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> <dev:code>#Example usage for getting street address for a lat/long pair. Import-Module pwps_dab Get-AddressForLatitudeLongitude -Latitude 36.008542 -Longitude -78.928718</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-ADFSToken --> <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-ADFSToken</command:name> <command:verb>Get</command:verb> <command:noun>ADFSToken</command:noun> <maml:description> <maml:para>Gets a service account token if available. Only certain accounts can have this.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ADFSToken</maml:name> <!-- Parameter: ADFSUser --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ADFSUser</maml:name> <maml:description> <maml:para>Valid ADFS 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: ADFSPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ADFSPassword</maml:name> <maml:description> <maml:para>Valid password</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: ADFSURL --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ADFSURL</maml:name> <maml:description> <maml:para>ADFS URL. e.g. https://adfs/adfs/services/trust/13/usernamemixed</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AppliesToURL --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>AppliesToURL</maml:name> <maml:description> <maml:para>Applies to URL. e.g. https://ims.bentley.com</maml: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: ADFSUser --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ADFSUser</maml:name> <maml:description> <maml:para>Valid ADFS 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: ADFSPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ADFSPassword</maml:name> <maml:description> <maml:para>Valid password</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: ADFSURL --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ADFSURL</maml:name> <maml:description> <maml:para>ADFS URL. e.g. https://adfs/adfs/services/trust/13/usernamemixed</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AppliesToURL --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>AppliesToURL</maml:name> <maml:description> <maml:para>Applies to URL. e.g. https://ims.bentley.com</maml: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:command> <!-- Cmdlet: Get-AzureIOTToken --> <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-AzureIOTToken</command:name> <command:verb>Get</command:verb> <command:noun>AzureIOTToken</command:noun> <maml:description> <maml:para>Get the Unix timestamp for now, UTC now or for a given date string.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Uri --> <command:syntaxItem> <maml:name>Get-AzureIOTToken</maml:name> <!-- Parameter: Uri --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Uri to get token for like "MyIOTHub.azure-devices.net".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Key --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Key</maml:name> <maml:description> <maml:para>Key for hub from Azure portal like "1YH3+T0yNn9iAZ8fUhccGXUWRCl8us4jeyVo5CasRmE=".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExpirationTime --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>ExpirationTime</maml:name> <maml:description> <maml:para>Expiration date string to parse like "2019-10-19 13:05:00".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExpirationSeconds --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>ExpirationSeconds</maml:name> <maml:description> <maml:para>Expiration time in seconds (e.g. (Get-UnixTimeStamp) + 3600).</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Policy --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>Policy</maml:name> <maml:description> <maml:para>Defaults to iothubowner 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> <dev:defaultValue>iothubowner</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Uri --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Uri to get token for like "MyIOTHub.azure-devices.net".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Key --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Key</maml:name> <maml:description> <maml:para>Key for hub from Azure portal like "1YH3+T0yNn9iAZ8fUhccGXUWRCl8us4jeyVo5CasRmE=".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExpirationTime --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>ExpirationTime</maml:name> <maml:description> <maml:para>Expiration date string to parse like "2019-10-19 13:05:00".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExpirationSeconds --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>ExpirationSeconds</maml:name> <maml:description> <maml:para>Expiration time in seconds (e.g. (Get-UnixTimeStamp) + 3600).</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Policy --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>Policy</maml:name> <maml:description> <maml:para>Defaults to iothubowner 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> <dev:defaultValue>iothubowner</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>Uri to get token for like "MyIOTHub.azure-devices.net".</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Key for hub from Azure portal like "1YH3+T0yNn9iAZ8fUhccGXUWRCl8us4jeyVo5CasRmE=".</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Expiration date string to parse like "2019-10-19 13:05:00".</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Expiration time in seconds (e.g. (Get-UnixTimeStamp) + 3600).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Defaults to iothubowner if not set.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-UnixTimestamp -UTC -Nanoseconds</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Export-DataTableToSQLiteDB --> <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-DataTableToSQLiteDB</command:name> <command:verb>Export</command:verb> <command:noun>DataTableToSQLiteDB</command:noun> <maml:description> <maml:para>Exports a datatable to a SQLite Database.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Exports a datatable to a SQLite Database.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Export-DataTableToSQLiteDB</maml:name> <!-- Parameter: SourceDataTable --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SourceDataTable</maml:name> <command:parameterValue required="true">DataTable</command:parameterValue> <dev:type> <maml:name>System.Data.DataTable</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: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <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: Append --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Append</maml:name> <maml:description> <maml:para>When included, the SQLite Database will be appended 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: Overwrite --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When included, the SQLite Database will be replaced/overwritten 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SourceDataTable --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SourceDataTable</maml:name> <command:parameterValue required="true">DataTable</command:parameterValue> <dev:type> <maml:name>System.Data.DataTable</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: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <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: Append --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Append</maml:name> <maml:description> <maml:para>When included, the SQLite Database will be appended 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: Overwrite --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When included, the SQLite Database will be replaced/overwritten 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> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Exports the SourceDataTable to a SQLite Database in the location specified. #SQLiteStudio seems like an adequate managment tool (http://sqlitestudio.pl/?act=download) for the resulting container. $dt = Get-PWDocumentReportDataTable -ProjectWiseFolder 'Design Drafting Projects\Test for Alignment Project' -Recurse $dt2 = $dt[0].Copy() Export-DataTableToSQLiteDB -SourceDataTable $dt2 -OutputFolder 'c:\temp'</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Appends the SourceDataTable to a SQLite Database in the location specified. $dt = Get-PWDocumentReportDataTable -ProjectWiseFolder 'Design Drafting Projects\Test for Alignment Project' -Recurse $dt2 = $dt[0].Copy() Export-DataTableToSQLiteDB -SourceDataTable $dt2 -OutputFolder 'c:\temp' -Append</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Overwrites (replaces) the existing SQLite Database. Exports the SourceDataTable to a SQLite Database in the location specified. $dt = Get-PWDocumentReportDataTable -ProjectWiseFolder 'Design Drafting Projects\Test for Alignment Project' -Recurse $dt2 = $dt[0].Copy() Export-DataTableToSQLiteDB -SourceDataTable $dt2 -OutputFolder 'c:\temp' -Overwrite</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-EncodedLogicalToken --> <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-EncodedLogicalToken</command:name> <command:verb>Get</command:verb> <command:noun>EncodedLogicalToken</command:noun> <maml:description> <maml:para>Convert to encoded token from logical username/password combination.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Convert to encoded token from logical username/password combination.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-EncodedLogicalToken</maml:name> <!-- Parameter: User --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>User</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: Password --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password.</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: User --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>User</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: Password --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password.</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>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>User name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Password.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$logicalToken = Get-EncodedLogicalToken -User LogicalUser -Password (Read-Host -Prompt "Password:" -AsSecureString)</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: ConvertFrom-EncodedToken --> <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>ConvertFrom-EncodedToken</command:name> <command:verb>ConvertFrom</command:verb> <command:noun>EncodedToken</command:noun> <maml:description> <maml:para>Convert from encoded token to readable string.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Convert from encoded token to readable string.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Token --> <command:syntaxItem> <maml:name>ConvertFrom-EncodedToken</maml:name> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>Encoded Token.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DoNotFormat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DoNotFormat</maml:name> <maml:description> <maml:para>Do not format the 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: Token --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>Encoded Token.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DoNotFormat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DoNotFormat</maml:name> <maml:description> <maml:para>Do not format the 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>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Encoded Token.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$readableToken = ConvertFrom-EncodedToken (Get-PWConnectionClientToken)</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: ConvertTo-EncodedToken --> <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>ConvertTo-EncodedToken</command:name> <command:verb>ConvertTo</command:verb> <command:noun>EncodedToken</command:noun> <maml:description> <maml:para>Convert to encoded token from readable string.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Convert to encoded token from readable string.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Token --> <command:syntaxItem> <maml:name>ConvertTo-EncodedToken</maml:name> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>Clear text token.</maml: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: Token --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>Clear text token.</maml: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>Clear text token.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$readableToken = ConvertFrom-EncodedToken (Get-PWConnectionClientToken) $usableToken = ConvertTo-EncodedToken $readableToken # $usableToken could be used as the -Token argument to Add-PWConnectedProject</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-LastPWErrorId --> <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-LastPWErrorId</command:name> <command:verb>Get</command:verb> <command:noun>LastPWErrorId</command:noun> <maml:description> <maml:para>Get the Id of the last PW error that occurred.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWFolders -FolderPah 'Top Level\Sub-Folder' | Get-PWManagedWorkspaces</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-LatitudeLongitudeForAddress --> <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-LatitudeLongitudeForAddress</command:name> <command:verb>Get</command:verb> <command:noun>LatitudeLongitudeForAddress</command:noun> <maml:description> <maml:para>Provides a latitude/longitude for a street address.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Address --> <command:syntaxItem> <maml:name>Get-LatitudeLongitudeForAddress</maml:name> <!-- Parameter: Address --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Address</maml:name> <maml:description> <maml:para>Address (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: Address --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Address</maml:name> <maml:description> <maml:para>Address (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> <dev:code>#Example usage for getting a lat/long pair for a street address. Import-Module pwps_dab Get-LatitudeLongitudeForAddress "Gracechurch St, London EC3V 1LT, UK"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-LogFileToSQLite --> <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-LogFileToSQLite</command:name> <command:verb>Import</command:verb> <command:noun>LogFileToSQLite</command:noun> <maml:description> <maml:para>Import a log file to a table in a SQLite database. If table or database does not exist, it will be created.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Import a log file to a table in a SQLite database. If table or database does not exist, it will be created.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Import-LogFileToSQLite</maml:name> <!-- Parameter: LogFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>LogFile</maml:name> <maml:description> <maml:para>Log file to import (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: OutputFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>Full path to new or existing SQLite database.</maml:para> </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="false" globbing="false" pipelineInput="false" position="2"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Defaults to LogData 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: ColumnDefinitions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ColumnDefinitions</maml:name> <maml:description> <maml:para>List of column layouts in the form of StartColumnIndex1, ColumnWidth1, StartColumnIndex2, ColumnWidth2, etc. (Default: 0, 23, 24, 5, 30, 10, 44, 999). If using default, which corresponds so the logging conversion pattern of "%d{ISO8601} %-5p [%t] %c - %m%n", cmdlet will split the last column at the dash.</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: PreviewData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>PreviewData</maml:name> <maml:description> <maml:para>Preview the first 20 inserts.</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: CustomData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>CustomData</maml:name> <maml:description> <maml:para>Anything you might want included in a CustomData column like server 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: ExitOnError --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ExitOnError</maml:name> <maml:description> <maml:para>Exit if the inserts fail. Will probably be data parsing error.</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: LogFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>LogFile</maml:name> <maml:description> <maml:para>Log file to import (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: OutputFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>Full path to new or existing SQLite database.</maml:para> </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="false" globbing="false" pipelineInput="false" position="2"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Defaults to LogData 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: ColumnDefinitions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ColumnDefinitions</maml:name> <maml:description> <maml:para>List of column layouts in the form of StartColumnIndex1, ColumnWidth1, StartColumnIndex2, ColumnWidth2, etc. (Default: 0, 23, 24, 5, 30, 10, 44, 999). If using default, which corresponds so the logging conversion pattern of "%d{ISO8601} %-5p [%t] %c - %m%n", cmdlet will split the last column at the dash.</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: PreviewData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>PreviewData</maml:name> <maml:description> <maml:para>Preview the first 20 inserts.</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: CustomData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>CustomData</maml:name> <maml:description> <maml:para>Anything you might want included in a CustomData column like server 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: ExitOnError --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ExitOnError</maml:name> <maml:description> <maml:para>Exit if the inserts fail. Will probably be data parsing error.</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> <dev:code># if using standard ConversionPattern "%d{ISO8601} %-5p [%t] %c - %m%n" there's no need to provide column definitions Import-LogFileToSQLite dmskrnl.log.1 -OutputFile c:\dboutput\logging.db</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-LogFileToSQLServer --> <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-LogFileToSQLServer</command:name> <command:verb>Import</command:verb> <command:noun>LogFileToSQLServer</command:noun> <maml:description> <maml:para>Import a log file to a table in a SQLite database. If table or database does not exist, it will be created.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Import a log file to a table in a SQLite database. If table or database does not exist, it will be created.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: LogFile --> <command:syntaxItem> <maml:name>Import-LogFileToSQLServer</maml:name> <!-- Parameter: LogFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>LogFile</maml:name> <maml:description> <maml:para>Log file to import (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: DatabaseServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DatabaseServer</maml:name> <maml:description> <maml:para>Target SQL database 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: CustomData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>CustomData</maml:name> <maml:description> <maml:para>Anything you might want included in a CustomData column like server 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: ExitOnError --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>ExitOnError</maml:name> <maml:description> <maml:para>Exit if the inserts fail. Will probably be data parsing error.</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: DatabaseName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Target SQL database 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: DatabaseUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>DatabaseUser</maml:name> <maml:description> <maml:para>Database 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: Password --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>Password</maml:name> <maml:description> <maml:para>Database password.</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: InsertStatement --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>InsertStatement</maml:name> <maml:description> <maml:para>Insert statement to use. Default: Insert into LogData values ('{0}','{1}','{2}','{3}','{4}','{5}')</maml:para> </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="false" globbing="false" pipelineInput="true (ByValue)" position="6"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Default is LogData</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseWindowsAuth --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="7"> <maml:name>UseWindowsAuth</maml:name> <maml:description> <maml:para>Switch to use Windows Authentication.</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: ColumnDefinitions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>ColumnDefinitions</maml:name> <maml:description> <maml:para>List of column layouts in the form of StartColumnIndex1, ColumnWidth1, StartColumnIndex2, ColumnWidth2, etc. (Default: 0, 23, 24, 5, 31, 10, 43, 999). If using default, which corresponds so the logging conversion pattern of "%d{ISO8601} %-5p [%t] %c - %m%n", cmdlet will split the last column at the dash.</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: PreviewData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>PreviewData</maml:name> <maml:description> <maml:para>Preview the first 20 inserts.</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: LogFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>LogFile</maml:name> <maml:description> <maml:para>Log file to import (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: DatabaseServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DatabaseServer</maml:name> <maml:description> <maml:para>Target SQL database 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: DatabaseName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Target SQL database 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: DatabaseUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>DatabaseUser</maml:name> <maml:description> <maml:para>Database 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: Password --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>Password</maml:name> <maml:description> <maml:para>Database password.</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: InsertStatement --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>InsertStatement</maml:name> <maml:description> <maml:para>Insert statement to use. Default: Insert into LogData values ('{0}','{1}','{2}','{3}','{4}','{5}')</maml:para> </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="false" globbing="false" pipelineInput="true (ByValue)" position="6"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Default is LogData</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseWindowsAuth --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="7"> <maml:name>UseWindowsAuth</maml:name> <maml:description> <maml:para>Switch to use Windows Authentication.</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: ColumnDefinitions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>ColumnDefinitions</maml:name> <maml:description> <maml:para>List of column layouts in the form of StartColumnIndex1, ColumnWidth1, StartColumnIndex2, ColumnWidth2, etc. (Default: 0, 23, 24, 5, 31, 10, 43, 999). If using default, which corresponds so the logging conversion pattern of "%d{ISO8601} %-5p [%t] %c - %m%n", cmdlet will split the last column at the dash.</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: PreviewData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>PreviewData</maml:name> <maml:description> <maml:para>Preview the first 20 inserts.</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: CustomData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>CustomData</maml:name> <maml:description> <maml:para>Anything you might want included in a CustomData column like server 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: ExitOnError --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>ExitOnError</maml:name> <maml:description> <maml:para>Exit if the inserts fail. Will probably be data parsing error.</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>Target SQL database server.</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 SQL database name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Database user.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Database password.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Insert statement to use. Default: Insert into LogData values ('{0}','{1}','{2}','{3}','{4}','{5}')</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Default is LogData</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>Switch to use Windows Authentication.</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> <dev:code>Import-LogFileToSQLServer c:\logs\dmskrnl.log.1 -DatabaseServer DBServerName -DatabaseName PWLogging -UseWindowsAuth -CustomData IntegrationServer</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-MicroStationEngines --> <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-MicroStationEngines</command:name> <command:verb>Get</command:verb> <command:noun>MicroStationEngines</command:noun> <maml:description> <maml:para>Get a listing of available MicroStation Engines.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-MicroStationEngines</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Convert-ObjectArrayToDataTable --> <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-ObjectArrayToDataTable</command:name> <command:verb>Convert</command:verb> <command:noun>ObjectArrayToDataTable</command:noun> <maml:description> <maml:para>Pass an array of PowerShell Objects to this cmdlet and have them converted to a table.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Pass an array of PowerShell Objects to this cmdlet and have them converted to a table.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputObjectArray --> <command:syntaxItem> <maml:name>Convert-ObjectArrayToDataTable</maml:name> <!-- Parameter: InputObjectArray --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InputObjectArray</maml:name> <maml:description> <maml:para>SQL Select statement to execute (Required).</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TableName</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: InputObjectArray --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InputObjectArray</maml:name> <maml:description> <maml:para>SQL Select statement to execute (Required).</maml:para> </maml:description> <command:parameterValue required="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TableName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TableName</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> <dev:code>$docs = Get-PWDocumentsBySearch -GetAttributes -GetVersionsToo $dt = Convert-ObjectArrayToDataTable $docs -TableName 'Test2' New-XLSXWorkbook $dt -OutputFileName c:\Output.xlsx</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PDFFonts --> <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-PDFFonts</command:name> <command:verb>Get</command:verb> <command:noun>PDFFonts</command:noun> <maml:description> <maml:para>Get the list of supported Fonts for use with Add-PWPDFWatermarkText.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PDFFonts</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PDFQRCode --> <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-PDFQRCode</command:name> <command:verb>Add</command:verb> <command:noun>PDFQRCode</command:noun> <maml:description> <maml:para>Apply arbitrary QR Code to PDF from File System.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: FileName --> <command:syntaxItem> <maml:name>Add-PDFQRCode</maml:name> <!-- Parameter: FileName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Documents to copy out and print (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: URL --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <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: StampInForeground --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>StampInForeground</maml:name> <maml:description> <maml:para>Stamp in Foreground.</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: X --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <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="3"> <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="4"> <maml:name>Size</maml:name> <maml:description> <maml:para>Size of image. Works best in multiples of 33 due to the way QR Code image is generated.</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>99</dev:defaultValue> </command:parameter> <!-- Parameter: NativeUnits --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>NativeUnits</maml:name> <maml:description> <maml:para>(Obsolete, not used). Units are in PDF Units. Set this if your QR Code is not showing up.</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: CropBorder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>CropBorder</maml:name> <maml:description> <maml:para>(Obsolete, not used). Number of units to crop around the edge of the QR Code (can have a lot of white border based on the size of the image). Use with NativeUnits switch.</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: RemoveImages --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>RemoveImages</maml:name> <maml:description> <maml:para>Remove the existing images.</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: OverWriteFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>OverWriteFile</maml:name> <maml:description> <maml:para>Will generate copy of the file 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: DoNotShortenURL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>DoNotShortenURL</maml:name> <maml:description> <maml:para>Won't attempt to shorten URL.</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: FileName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Documents to copy out and print (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: URL --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <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="2"> <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="3"> <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="4"> <maml:name>Size</maml:name> <maml:description> <maml:para>Size of image. Works best in multiples of 33 due to the way QR Code image is generated.</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>99</dev:defaultValue> </command:parameter> <!-- Parameter: NativeUnits --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>NativeUnits</maml:name> <maml:description> <maml:para>(Obsolete, not used). Units are in PDF Units. Set this if your QR Code is not showing up.</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: CropBorder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>CropBorder</maml:name> <maml:description> <maml:para>(Obsolete, not used). Number of units to crop around the edge of the QR Code (can have a lot of white border based on the size of the image). Use with NativeUnits switch.</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: RemoveImages --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>RemoveImages</maml:name> <maml:description> <maml:para>Remove the existing images.</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: OverWriteFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>OverWriteFile</maml:name> <maml:description> <maml:para>Will generate copy of the file 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: DoNotShortenURL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>DoNotShortenURL</maml:name> <maml:description> <maml:para>Won't attempt to shorten URL.</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: StampInForeground --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>StampInForeground</maml:name> <maml:description> <maml:para>Stamp in Foreground.</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>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>Provide this value instead to produce a generic code.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#URL can be any valid URL. Add-PDFQRCode c:\PDFs\PDF1.pdf -URL www.bentley.com -X 100 -Y 100 -Size 100 #Try NativeUnits flag if QR Code is too small or invisible. Use -RemoveImages to remove QR Code from previously stamped PDF. Add-PDFQRCode c:\PDFs\PDF1.pdf -URL www.bentley.com -X 100 -Y 100 -Size 100 -NativeUnits -RemoveImages</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PDFTextColors --> <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-PDFTextColors</command:name> <command:verb>Get</command:verb> <command:noun>PDFTextColors</command:noun> <maml:description> <maml:para>Get PDF Text Colors for use with Add-PWPDFWatermarkText.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PDFTextColors</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PDFWatermarkText --> <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-PDFWatermarkText</command:name> <command:verb>Add</command:verb> <command:noun>PDFWatermarkText</command:noun> <maml:description> <maml:para>Apply arbitrary QR Code to PDF from File System.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: FileName --> <command:syntaxItem> <maml:name>Add-PDFWatermarkText</maml:name> <!-- Parameter: FileName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Documents to copy out and print (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: Text --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Text</maml:name> <maml:description> <maml:para>Watermark Text.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OverWriteFile --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="10"> <maml:name>OverWriteFile</maml:name> <maml:description> <maml:para>Overwrite input 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> <!-- Parameter: X --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>X</maml:name> <maml:description> <maml:para>X coordinate of watermark. Default is 50.</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>50</dev:defaultValue> </command:parameter> <!-- Parameter: Y --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>Y</maml:name> <maml:description> <maml:para>Y coordinate of watermark. Default is 50.</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>50</dev:defaultValue> </command:parameter> <!-- Parameter: TextSize --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>TextSize</maml:name> <maml:description> <maml:para>Text size for link text. (Defaults to 10).</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>10</dev:defaultValue> </command:parameter> <!-- Parameter: Opacity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>Opacity</maml:name> <maml:description> <maml:para>Opacity. (Defaults to 50, 100 = completly opaque).</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>50</dev:defaultValue> </command:parameter> <!-- Parameter: Rotation --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="6"> <maml:name>Rotation</maml:name> <maml:description> <maml:para>Rotation degrees. (Defaults to 0).</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: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="7"> <maml:name>Color</maml:name> <maml:description> <maml:para>Foreground color for text. (Default is Black).</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>Black</dev:defaultValue> </command:parameter> <!-- Parameter: Font --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="8"> <maml:name>Font</maml:name> <maml:description> <maml:para>Font for text. (Default is Helvetica).</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>Helvetica</dev:defaultValue> </command:parameter> <!-- Parameter: WatermarkInForeground --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="9"> <maml:name>WatermarkInForeground</maml:name> <maml:description> <maml:para>Put watermark in the foreground.</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: FileName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Documents to copy out and print (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: Text --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Text</maml:name> <maml:description> <maml:para>Watermark Text.</maml:para> </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="true (ByValue)" position="2"> <maml:name>X</maml:name> <maml:description> <maml:para>X coordinate of watermark. Default is 50.</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>50</dev:defaultValue> </command:parameter> <!-- Parameter: Y --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>Y</maml:name> <maml:description> <maml:para>Y coordinate of watermark. Default is 50.</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>50</dev:defaultValue> </command:parameter> <!-- Parameter: TextSize --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>TextSize</maml:name> <maml:description> <maml:para>Text size for link text. (Defaults to 10).</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>10</dev:defaultValue> </command:parameter> <!-- Parameter: Opacity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>Opacity</maml:name> <maml:description> <maml:para>Opacity. (Defaults to 50, 100 = completly opaque).</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>50</dev:defaultValue> </command:parameter> <!-- Parameter: Rotation --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="6"> <maml:name>Rotation</maml:name> <maml:description> <maml:para>Rotation degrees. (Defaults to 0).</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: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="7"> <maml:name>Color</maml:name> <maml:description> <maml:para>Foreground color for text. (Default is Black).</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>Black</dev:defaultValue> </command:parameter> <!-- Parameter: Font --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="8"> <maml:name>Font</maml:name> <maml:description> <maml:para>Font for text. (Default is Helvetica).</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>Helvetica</dev:defaultValue> </command:parameter> <!-- Parameter: WatermarkInForeground --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="9"> <maml:name>WatermarkInForeground</maml:name> <maml:description> <maml:para>Put watermark in the foreground.</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: OverWriteFile --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="10"> <maml:name>OverWriteFile</maml:name> <maml:description> <maml:para>Overwrite input 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>System.String</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>Watermark Text.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>X coordinate of watermark. Default is 50.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Y coordinate of watermark. Default is 50.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Text size for link text. (Defaults to 10).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Opacity. (Defaults to 50, 100 = completly opaque).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Rotation degrees. (Defaults to 0).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Foreground color for text. (Default is Black).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Font for text. (Default is Helvetica).</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>Put watermark in the foreground.</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>Overwrite input file.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#URL can be any valid URL. Add-PDFQRCode c:\PDFs\PDF1.pdf -URL www.bentley.com -X 100 -Y 100 -Size 100 #Try NativeUnits flag if QR Code is too small or invisible. Use -RemoveImages to remove QR Code from previously stamped PDF. Add-PDFQRCode c:\PDFs\PDF1.pdf -URL www.bentley.com -X 100 -Y 100 -Size 100 -NativeUnits -RemoveImages</dev:code> </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> <dev:code>Export-PWAAMFile "c:\temp\environments.aam"</dev:code> </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> <dev:code>Import-PWAAMFile "c:\temp\environments.aam"</dev:code> </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> </command:details> <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: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> </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: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> </command:details> <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: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:command> <!-- Cmdlet: Get-PWActiveServerVersion --> <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-PWActiveServerVersion</command:name> <command:verb>Get</command:verb> <command:noun>PWActiveServerVersion</command:noun> <maml:description> <maml:para>Get server product 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> <dev:code>Get-PWServerVersion</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Clear-PWAdministratorGranularSecurity --> <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-PWAdministratorGranularSecurity</command:name> <command:verb>Clear</command:verb> <command:noun>PWAdministratorGranularSecurity</command:noun> <maml:description> <maml:para>Clears granular security for ProjectWise Administrator Nodes.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Nodes --> <command:syntaxItem> <maml:name>Clear-PWAdministratorGranularSecurity</maml:name> <!-- Parameter: Nodes --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Nodes</maml:name> <maml:description> <maml:para>Target ProjectWise Administrator nodes.</maml:para> </maml:description> <command:parameterValue required="true">AdministratorNodes[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.AdministratorNodes[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RemoveAll --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>RemoveAll</maml:name> <maml:description> <maml:para>Switch to remove granular security from all nodes.</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: Nodes --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Nodes</maml:name> <maml:description> <maml:para>Target ProjectWise Administrator nodes.</maml:para> </maml:description> <command:parameterValue required="true">AdministratorNodes[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.AdministratorNodes[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RemoveAll --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>RemoveAll</maml:name> <maml:description> <maml:para>Switch to remove granular security from all nodes.</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.AdministratorNodes[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target ProjectWise Administrator nodes.</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>Switch to remove granular security from all nodes.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Clear-PWAdministratorGranularSecurity -Nodes Coordinate_System, Symbologies, Background_Maps, Spatial_Metadata_Scanners, Rules_Engine, Renditions Clear-PWAdministratorGranularSecurity -RemoveAll</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWAdministratorGranularSecurity --> <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-PWAdministratorGranularSecurity</command:name> <command:verb>Set</command:verb> <command:noun>PWAdministratorGranularSecurity</command:noun> <maml:description> <maml:para>Set granular security for ProjectWise Administrator Nodes.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Nodes --> <command:syntaxItem> <maml:name>Set-PWAdministratorGranularSecurity</maml:name> <!-- Parameter: Nodes --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Nodes</maml:name> <maml:description> <maml:para>Target ProjectWise Administrator nodes. Exclude to apply to all nodes.</maml:para> </maml:description> <command:parameterValue required="true">AdministratorNodes[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.AdministratorNodes[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Groups to apply access 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: Users --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Users</maml:name> <maml:description> <maml:para>Users to apply access 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: UserLists --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>UserLists</maml:name> <maml:description> <maml:para>User Lists to apply access 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: Access --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>Access</maml:name> <maml:description> <maml:para>Access specifies the granular access control to be applied.</maml:para> <maml:para>Possible values: No_Access, Change_Settings, Change_Permissions_And_Settings, Full_Control</maml:para> </maml:description> <command:parameterValue required="true">GranularAccess</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.GranularAccess</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>No_Access</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">No_Access</command:parameterValue> <command:parameterValue required="false" variableLength="false">Change_Settings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Change_Permissions_And_Settings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Full_Control</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Nodes --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Nodes</maml:name> <maml:description> <maml:para>Target ProjectWise Administrator nodes. Exclude to apply to all nodes.</maml:para> </maml:description> <command:parameterValue required="true">AdministratorNodes[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.AdministratorNodes[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Groups --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Groups to apply access 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: Users --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Users</maml:name> <maml:description> <maml:para>Users to apply access 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: UserLists --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>UserLists</maml:name> <maml:description> <maml:para>User Lists to apply access 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: Access --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>Access</maml:name> <maml:description> <maml:para>Access specifies the granular access control to be applied.</maml:para> <maml:para>Possible values: No_Access, Change_Settings, Change_Permissions_And_Settings, Full_Control</maml:para> </maml:description> <command:parameterValue required="true">GranularAccess</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.GranularAccess</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>No_Access</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">No_Access</command:parameterValue> <command:parameterValue required="false" variableLength="false">Change_Settings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Change_Permissions_And_Settings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Full_Control</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.AdministratorNodes[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target ProjectWise Administrator nodes. Exclude to apply to all nodes.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Groups to apply access for.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Users to apply access for.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>User Lists to apply access for.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PWPS_DAB.GranularAccess</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Access specifies the granular access control to be applied.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Set-PWAdministratorGranularSecurity -UserLists "Project Administrators","Discipline Admins" -Access Full_Control Set-PWAdministratorGranularSecurity -Nodes Coordinate_System, Symbologies, Background_Maps, Spatial_Metadata_Scanners, Rules_Engine, Renditions -UserLists "Granular","Granular 2" -Access No_Access</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Copy-PWAFPProcessors --> <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-PWAFPProcessors</command:name> <command:verb>Copy</command:verb> <command:noun>PWAFPProcessors</command:noun> <maml:description> <maml:para>To be run against Orchestration Framework database to clone the AFP Processor Names. Should only be required once.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Copy-PWAFPProcessors</maml:name> <!-- Parameter: DatabaseServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>DatabaseServer</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabaseName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabaseUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>DatabaseUser</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabasePwd --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>DatabasePwd</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database password.</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: UseWindowsAuth --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>UseWindowsAuth</maml:name> <maml:description> <maml:para>Switch to use Windows Authentication.</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: MachineName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>MachineName</maml:name> <maml:description> <maml:para>Machine name for processors.</maml: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: DatabaseServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>DatabaseServer</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabaseName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabaseUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>DatabaseUser</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabasePwd --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>DatabasePwd</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database password.</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: UseWindowsAuth --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>UseWindowsAuth</maml:name> <maml:description> <maml:para>Switch to use Windows Authentication.</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: MachineName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>MachineName</maml:name> <maml:description> <maml:para>Machine name for processors.</maml: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>Orchestration Framework/iCS database server.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Orchestration Framework/iCS database name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Orchestration Framework/iCS database user.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Orchestration Framework/iCS database password.</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>Switch to use Windows Authentication.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Machine name for processors.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Copy-PWAFPProcessors -DatabaseServer ServerName -DatabaseName OF -UseWindowsAuth"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWAFPQueueNames --> <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-PWAFPQueueNames</command:name> <command:verb>Update</command:verb> <command:noun>PWAFPQueueNames</command:noun> <maml:description> <maml:para>To be run against Orchestration Framework database to update the AFP Queue Names. Should only be required once.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-PWAFPQueueNames</maml:name> <!-- Parameter: DatabaseServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>DatabaseServer</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabaseName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabaseUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>DatabaseUser</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabasePwd --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>DatabasePwd</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database password.</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: UseWindowsAuth --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>UseWindowsAuth</maml:name> <maml:description> <maml:para>Switch to use Windows Authentication.</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: DatabaseServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>DatabaseServer</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabaseName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabaseUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>DatabaseUser</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabasePwd --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>DatabasePwd</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database password.</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: UseWindowsAuth --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>UseWindowsAuth</maml:name> <maml:description> <maml:para>Switch to use Windows Authentication.</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>Orchestration Framework/iCS database server.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Orchestration Framework/iCS database name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Orchestration Framework/iCS database user.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Orchestration Framework/iCS database password.</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>Switch to use Windows Authentication.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Update-PWAFPQueueNames -DatabaseServer ServerName -DatabaseName OF -UseWindowsAuth"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWAllOwnedConnectedProjectIds --> <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-PWAllOwnedConnectedProjectIds</command:name> <command:verb>Get</command:verb> <command:noun>PWAllOwnedConnectedProjectIds</command:noun> <maml:description> <maml:para>Gets a list of all the user's owned CONNECTED project Ids.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Typical use case is a bulk delete.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWAllOwnedConnectedProjectIds</maml:name> <!-- Parameter: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="1"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Token</maml:name> <maml:description> <maml:para>CONNECT Token.</maml: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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="1"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Token</maml:name> <maml:description> <maml:para>CONNECT Token.</maml: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> <dev:code>$projects=Get-PWAllOwnedConnectedProjectIdss foreach ($proj in $projects){ $proj }</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWAllOwnedConnectedProjects --> <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-PWAllOwnedConnectedProjects</command:name> <command:verb>Get</command:verb> <command:noun>PWAllOwnedConnectedProjects</command:noun> <maml:description> <maml:para>Gets a list of all the user's owned CONNECTED projects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a list of all the user's owned CONNECTED projects.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWAllOwnedConnectedProjects</maml:name> <!-- Parameter: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="1"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Token</maml:name> <maml:description> <maml:para>CONNECT token.</maml: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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="1"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Token</maml:name> <maml:description> <maml:para>CONNECT token.</maml: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> <dev:code>$projects=Get-PWAllOwnedConnectedProjects foreach ($proj in $projects){ $proj.Project }</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWApplication --> <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-PWApplication</command:name> <command:verb>New</command:verb> <command:noun>PWApplication</command:noun> <maml:description> <maml:para>Create a new application within current datasource.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-PWApplication</maml:name> <!-- Parameter: ApplicationName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>Name of new application 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ApplicationName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>Name of new application 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> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Creates a new application named 'MyApplication'. New-PWApplication -ApplicationName 'MyApplication' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWApplication --> <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-PWApplication</command:name> <command:verb>Remove</command:verb> <command:noun>PWApplication</command:noun> <maml:description> <maml:para>Removes an application from current datasource.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-PWApplication</maml:name> <!-- Parameter: ApplicationName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>Name of application 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: ApplicationName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>Name of application 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> <dev:code>Removes an application named 'MyApplication'. Remove-PWApplication -ApplicationName 'MyApplication' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWApplicationExtensions --> <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-PWApplicationExtensions</command:name> <command:verb>Set</command:verb> <command:noun>PWApplicationExtensions</command:noun> <maml:description> <maml:para>Adds a file extension to a specified application within current datasource.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWApplicationExtensions</maml:name> <!-- Parameter: ApplicationName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>Name of new application 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: Extensions --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Extensions</maml:name> <maml:description> <maml:para>Name of file extensions to be added to application.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MoveIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MoveIfExists</maml:name> <maml:description> <maml:para>When included, if the file extension exists, it will be moved to the specified application.</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: ApplicationName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ApplicationName</maml:name> <maml:description> <maml:para>Name of new application 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: Extensions --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Extensions</maml:name> <maml:description> <maml:para>Name of file extensions to be added to application.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MoveIfExists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MoveIfExists</maml:name> <maml:description> <maml:para>When included, if the file extension exists, it will be moved to the specified application.</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> <dev:code>Adds file extensions to application 'MyApplication'. If the extension exists, it will be ignored. Set-PWApplicationExtensions -ApplicationName 'MyApplication' -Extensions 'txt' 'ps1' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Adds file extensions to application 'MyApplication'. If the extension exists, it will be moved. Set-PWApplicationExtensions -ApplicationName 'MyApplication' -Extensions 'txt' 'ps1' -MoveIfExists -Verbose</dev:code> </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: Set-PWAttributeDefaultValueSettings --> <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-PWAttributeDefaultValueSettings</command:name> <command:verb>Set</command:verb> <command:noun>PWAttributeDefaultValueSettings</command:noun> <maml:description> <maml:para>Set-PWAttributeDefaultValueSettings updates an attribute's Default Value settings values within a specified environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-PWAttributeDefaultValueSettings updates an attribute's Default Value settings values within a specified environment. The available settings are Default Value Type and Value. NOTE: When specifying a System Variable, be sure to surround in single quotes.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWAttributeDefaultValueSettings</maml:name> <!-- Parameter: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment containing attribute 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultValueType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>DefaultValueType</maml:name> <maml:description> <maml:para>Specifies the Default Value type for the specified attribute.</maml:para> <maml:para>Acceptable values: "None", "Fixed", "Select", "System variable", "Function".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultValueText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DefaultValueText</maml:name> <maml:description> <maml:para>Specifies the Default Value 'value' for the specified attribute. NOTE: When specifying a System Variable, be sure to surround in single quotes.</maml: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 containing attribute 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultValueType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>DefaultValueType</maml:name> <maml:description> <maml:para>Specifies the Default Value type for the specified attribute.</maml:para> <maml:para>Acceptable values: "None", "Fixed", "Select", "System variable", "Function".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DefaultValueText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DefaultValueText</maml:name> <maml:description> <maml:para>Specifies the Default Value 'value' for the specified attribute. NOTE: When specifying a System Variable, be sure to surround in single quotes.</maml: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> <dev:code>Example usage for setting an attribute's Default Value settings values. Sets Type to fixed and value to TEST. Set-PWAttributeDefaultValueSettings -EnvironmentName 'Complex' -AttributeName 'Title3' -DefaultValueType Fixed -DefaultValueText "TEST" -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWAttributeEditingSettings --> <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-PWAttributeEditingSettings</command:name> <command:verb>Set</command:verb> <command:noun>PWAttributeEditingSettings</command:noun> <maml:description> <maml:para>Set-PWAttributeEditingSettings updates an attribute's Editing settings values within a specified environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-PWAttributeEditingSettings updates an attribute's Editing settings values within a specified environment. The available settings are Control Type, Control Font, Control Font Size, Format String, and Maximum Input Text Length.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWAttributeEditingSettings</maml:name> <!-- Parameter: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment containing attribute to set the Editing settings 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ControlType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ControlType</maml:name> <maml:description> <maml:para>Attribute editing control type.</maml:para> <maml:para>Acceptable values: 'Edit field', 'Checkbox', 'Multiline edit field'</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ControlFont --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ControlFont</maml:name> <maml:description> <maml:para>Attribute editing control font 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: FormatString --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>FormatString</maml:name> <maml:description> <maml:para>Attribute editing format 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: ControlFontSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ControlFontSize</maml:name> <maml:description> <maml:para>Attribue editing control font size.</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: MaximumInputTextLength --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>MaximumInputTextLength</maml:name> <maml:description> <maml:para>Attribue editing maximum input text length.</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>Environment containing attribute to set the Editing settings 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ControlType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ControlType</maml:name> <maml:description> <maml:para>Attribute editing control type.</maml:para> <maml:para>Acceptable values: 'Edit field', 'Checkbox', 'Multiline edit field'</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ControlFont --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ControlFont</maml:name> <maml:description> <maml:para>Attribute editing control font 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: ControlFontSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ControlFontSize</maml:name> <maml:description> <maml:para>Attribue editing control font size.</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: FormatString --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>FormatString</maml:name> <maml:description> <maml:para>Attribute editing format 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: MaximumInputTextLength --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>MaximumInputTextLength</maml:name> <maml:description> <maml:para>Attribue editing maximum input text length.</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> <dev:code>Example usage for setting an attribute's Editing settings values. Sets Control Type to a checkbox. Set-PWAttributeEditingSettings -EnvironmentName 'Complex' -AttributeName 'Title1' -ControlType CheckBox -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Example usage for setting an attribute's Editing settings values. Sets Control font to Calibri and Control font size to 12. Set-PWAttributeEditingSettings -EnvironmentName 'Complex' -AttributeName 'Title2' -ControlFont "Calibri" -ControlFontSize 12 -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Example usage for setting an attribute's Editing settings values. Sets format string to UpperCase and Maximum input text length to 50. Set-PWAttributeEditingSettings -EnvironmentName 'Complex' -AttributeName 'Title2' -FormatString UpperCase -MaximumInputTextLength 50 -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWAttributeExchangeRulesUpdateFileConditions --> <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-PWAttributeExchangeRulesUpdateFileConditions</command:name> <command:verb>Get</command:verb> <command:noun>PWAttributeExchangeRulesUpdateFileConditions</command:noun> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Set-PWAttributeExchangeRulesUpdateFileConditions --> <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-PWAttributeExchangeRulesUpdateFileConditions</command:name> <command:verb>Set</command:verb> <command:noun>PWAttributeExchangeRulesUpdateFileConditions</command:noun> <maml:description> <maml:para>Sets the attribute exchange Update file conditions.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets the attribute exchange Update file conditions for the current datasource. Include the settings to toggle on. Any not included will be toggled off.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWAttributeExchangeRulesUpdateFileConditions</maml:name> <!-- Parameter: ExchangeRulesType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ExchangeRulesType</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CheckedOut --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckedOut</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: CopiedOut --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CopiedOut</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: Exported --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exported</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: Opened --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Opened</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: ExchangeRulesType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ExchangeRulesType</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Opened --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Opened</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: CheckedOut --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckedOut</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: CopiedOut --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CopiedOut</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: Exported --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Exported</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> <dev:code>The following toggle on the MicroStation Title Blocks Update file conditions for Document is "Opened" and Document is "Checked Out". Set-PWAttributeExchangeRulesUpdateFileConditions -ExchangeRulesType MicroStation -Opened -CheckedOut</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>The following toggle off ALL of the Microsoft Office Attribute Support Update file conditions". Set-PWAttributeExchangeRulesUpdateFileConditions -ExchangeRulesType Office</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWAttributeExchangeVersionRecord --> <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-PWAttributeExchangeVersionRecord</command:name> <command:verb>Add</command:verb> <command:noun>PWAttributeExchangeVersionRecord</command:noun> <maml:description> <maml:para>Manipulate Attribute Exchange Version Records.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-PWAttributeExchangeVersionRecord</maml:name> <!-- Parameter: Update --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Update</maml:name> <maml:description> <maml:para>Will add record or update existing record. Default is to add new.</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: MinorVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MinorVersion</maml:name> <maml:description> <maml:para>Minor version to update to. Defaults to 0.</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: Update --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Update</maml:name> <maml:description> <maml:para>Will add record or update existing record. Default is to add new.</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: MinorVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MinorVersion</maml:name> <maml:description> <maml:para>Minor version to update to. Defaults to 0.</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> <dev:code>Add-PWAttributeExchangeVersionRecord</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWAttributeExchangeVersionRecord --> <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-PWAttributeExchangeVersionRecord</command:name> <command:verb>Remove</command:verb> <command:noun>PWAttributeExchangeVersionRecord</command:noun> <maml:description> <maml:para>Manipulate Attribute Exchange Version Records.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-PWAttributeExchangeVersionRecord</maml:name> <!-- Parameter: MinorVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>MinorVersion</maml:name> <maml:description> <maml:para>Minor version to remove. Defaults to 0.</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: MinorVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>MinorVersion</maml:name> <maml:description> <maml:para>Minor version to remove. Defaults to 0.</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> <dev:code>Add-PWAttributeExchangeVersionRecord</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWAttributeExtraValuesSettings --> <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-PWAttributeExtraValuesSettings</command:name> <command:verb>Set</command:verb> <command:noun>PWAttributeExtraValuesSettings</command:noun> <maml:description> <maml:para>Set-PWAttributeExtraValuesSettings updates an attribute's Extra Values within a specified environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-PWAttributeExtraValuesSettings updates an attribute's Extra Values within a specified environment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWAttributeExtraValuesSettings</maml:name> <!-- Parameter: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment containing attribute to add Extra Values 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExtraValue01 --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ExtraValue01</maml:name> <maml:description> <maml:para>Attribute extra value 1.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExtraValue02 --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ExtraValue02</maml:name> <maml:description> <maml:para>Attribute extra value 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: ExtraValue03 --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ExtraValue03</maml:name> <maml:description> <maml:para>Attribute extra value 3.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExtraValue04 --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>ExtraValue04</maml:name> <maml:description> <maml:para>Attribute extra value 4.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExtraValue05 --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ExtraValue05</maml:name> <maml:description> <maml:para>Attribute extra value 5.</maml: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 containing attribute to add Extra Values 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExtraValue01 --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ExtraValue01</maml:name> <maml:description> <maml:para>Attribute extra value 1.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExtraValue02 --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ExtraValue02</maml:name> <maml:description> <maml:para>Attribute extra value 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: ExtraValue03 --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ExtraValue03</maml:name> <maml:description> <maml:para>Attribute extra value 3.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExtraValue04 --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>ExtraValue04</maml:name> <maml:description> <maml:para>Attribute extra value 4.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExtraValue05 --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ExtraValue05</maml:name> <maml:description> <maml:para>Attribute extra value 5.</maml: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> <dev:code>Example usage for setting an attribute's Extra Values. Set-PWAttributeExtraValuesSettings -EnvironmentName 'Complex' -AttributeName 'Title1' -ExtraValue01 "TestValue01" -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWAttributeFromInterface --> <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-PWAttributeFromInterface</command:name> <command:verb>Remove</command:verb> <command:noun>PWAttributeFromInterface</command:noun> <maml:description> <maml:para>Removes an attribute from an interface for a specified environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes the specified attribute from the specified interface within the specified environment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-PWAttributeFromInterface</maml:name> <!-- Parameter: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AttributeName</maml:name> <maml:description> <maml:para>Attribute to be removed from the 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: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment containing attribute to remove from 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: InterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>InterfaceName</maml:name> <maml:description> <maml:para>Interface to remove attribute 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment containing attribute to remove from 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: InterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>InterfaceName</maml:name> <maml:description> <maml:para>Interface to remove attribute 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AttributeName</maml:name> <maml:description> <maml:para>Attribute to be removed from the 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> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for Remove-PWAttributeFromInterface. #Removes the Title4 attribute from the 'Default' interface within the 'Simple' environment. Remove-PWAttributeFromInterface -EnvironmentName 'Simple' -InterfaceName 'Default' -AttributeName 'Title4' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWAttributeGeneralSettings --> <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-PWAttributeGeneralSettings</command:name> <command:verb>Set</command:verb> <command:noun>PWAttributeGeneralSettings</command:noun> <maml:description> <maml:para>Set-PWAttributeGeneralSettings updates an attribute's General settings values within a specified environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-PWAttributeGeneralSettings updates an attribute's General settings values within a specified environment. The available settings are Unique, Required, Access, Copied inside document, Copied inside environment, and Copied or moved from other environment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWAttributeGeneralSettings</maml:name> <!-- Parameter: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment containing attribute 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AttributeValueUnique --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>AttributeValueUnique</maml:name> <maml:description> <maml:para>Toggles on/off the Attribute value Unique. Valid entries: On, Off.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AttributeValueAccess --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>AttributeValueAccess</maml:name> <maml:description> <maml:para>Sets the Attribute Access value to edit or read-only. Valid entries: Edit, Read-Only.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AttributeValueRequired --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>AttributeValueRequired</maml:name> <maml:description> <maml:para>Toggles on/off the Attribute value Required. Valid entries: On, Off.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CopiedInsideDocument --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>CopiedInsideDocument</maml:name> <maml:description> <maml:para>Toggles on/off the Clear Attribute value when Copied inside document. Valid entries: On, Off.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CopiedInsideEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>CopiedInsideEnvironment</maml:name> <maml:description> <maml:para>Toggles on/off the Clear Attribute value when Copied inside environment. Valid entries: On, Off.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CopiedOrMovedFromOtherEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>CopiedOrMovedFromOtherEnvironment</maml:name> <maml:description> <maml:para>Toggles on/off the Clear Attribute value when Copied or moved from other environment. Valid entries: On, Off.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AttributeValueEditableIfFinal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AttributeValueEditableIfFinal</maml:name> <maml:description> <maml:para>Toggles on/off the Attribute value Editable if final. Valid entries: On, Off.</maml: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 containing attribute 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AttributeValueUnique --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>AttributeValueUnique</maml:name> <maml:description> <maml:para>Toggles on/off the Attribute value Unique. Valid entries: On, Off.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AttributeValueRequired --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>AttributeValueRequired</maml:name> <maml:description> <maml:para>Toggles on/off the Attribute value Required. Valid entries: On, Off.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AttributeValueEditableIfFinal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AttributeValueEditableIfFinal</maml:name> <maml:description> <maml:para>Toggles on/off the Attribute value Editable if final. Valid entries: On, Off.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AttributeValueAccess --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>AttributeValueAccess</maml:name> <maml:description> <maml:para>Sets the Attribute Access value to edit or read-only. Valid entries: Edit, Read-Only.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CopiedInsideDocument --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>CopiedInsideDocument</maml:name> <maml:description> <maml:para>Toggles on/off the Clear Attribute value when Copied inside document. Valid entries: On, Off.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CopiedInsideEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>CopiedInsideEnvironment</maml:name> <maml:description> <maml:para>Toggles on/off the Clear Attribute value when Copied inside environment. Valid entries: On, Off.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CopiedOrMovedFromOtherEnvironment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>CopiedOrMovedFromOtherEnvironment</maml:name> <maml:description> <maml:para>Toggles on/off the Clear Attribute value when Copied or moved from other environment. Valid entries: On, Off.</maml: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> <dev:code>Example usage for setting an attribute's General settings values. Toggles On Attribute value Unique. Set-PWAttributeEditingSettings -EnvironmentName 'Complex' -AttributeName 'Title1' -AttributeValueUnique On -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Example usage for setting an attribute's General settings values. Toggles Off Attribute value Required. Set-PWAttributeEditingSettings -EnvironmentName 'Complex' -AttributeName 'Title1' -AttributeValueRequired Off -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Example usage for setting an attribute's General settings values. Sets the Attribute value Access to Read-only. Set-PWAttributeEditingSettings -EnvironmentName 'Complex' -AttributeName 'Title1' -AttributeValueAccess Read-only -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>Example usage for setting an attribute's General settings values. Toggles On Clear Attribute value when Copied inside document. Set-PWAttributeEditingSettings -EnvironmentName 'Complex' -AttributeName 'Title1' -CopiedInsideDocument On -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>Example usage for setting an attribute's General settings values. Toggles Off Clear Attribute value when Copied or moved from other environment. Set-PWAttributeEditingSettings -EnvironmentName 'Complex' -AttributeName 'Title1' -CopiedOrMovedFromOtherEnvironment Off -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWAttributeSettings --> <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-PWAttributeSettings</command:name> <command:verb>Get</command:verb> <command:noun>PWAttributeSettings</command:noun> <maml:description> <maml:para>Returns the settings for a specified attribute.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a datarow containing the settings for the specified attribute in the specified ProjectWise Environment.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWAttributeSettings</maml:name> <!-- Parameter: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment containing attribute 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</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: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment containing attribute 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</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: DataRow --> <command:returnValue> <dev:type> <maml:name>System.Data.DataRow</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Will return for attribute 'DocumentType' in the 'Simple' environment. Get-PWAttributeSettings -EnvironmentName 'Simple' -AttributeName 'DocumentType' -Verbose</dev:code> </command:example> </command:examples> </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 the More Attributes page of an interface.</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 environment containing attribute 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: InterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>InterfaceName</maml:name> <maml:description> <maml:para>Name of interface to add attribute 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>AttributeName</maml:name> <maml:description> <maml:para>Name of attribute to add to More Attributes page.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LabelText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>LabelText</maml:name> <maml:description> <maml:para>Label text used to update GUI definition.</maml: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 containing attribute 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: InterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>InterfaceName</maml:name> <maml:description> <maml:para>Name of interface to add attribute 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>AttributeName</maml:name> <maml:description> <maml:para>Name of attribute to add to More Attributes page.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LabelText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>LabelText</maml:name> <maml:description> <maml:para>Label text used to update GUI definition.</maml: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> <dev:code>#Example usage for Add-PWAttributeToInterface. Adds DrawingNumber attribute to the More Attributes page of the Manager interface for Complex environment. Add-PWAttributeToInterface -EnvironmentName Complex -Interface Manager -ColumnName DrawingNumber -Verbose </dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Adds DrawingNumber attribute with a label to the More Attributes page of the Manager interface for Complex environment. Add-PWAttributeToInterface -EnvironmentName Complex -Interface Manager -ColumnName DrawingNumber -LabelText "Drawing Number:" -Verbose </dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWAttributeUpdateValueSettings --> <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-PWAttributeUpdateValueSettings</command:name> <command:verb>Set</command:verb> <command:noun>PWAttributeUpdateValueSettings</command:noun> <maml:description> <maml:para>Set-PWAttributeUpdateValueSettings updates an attribute's Update Value settings values within a specified environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-PWAttributeUpdateValueSettings updates an attribute's Update Value settings values within a specified environment. The available settings are Update Value Type, Value. NOTE: When specifying a System Variable, be sure to surround in single quotes.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWAttributeUpdateValueSettings</maml:name> <!-- Parameter: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment containing attribute 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UpdateValueType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>UpdateValueType</maml:name> <maml:description> <maml:para>Specifies the Update Value type for the specified attribute.</maml:para> <maml:para>Acceptable values: "None", "Fixed", "Select", "System variable", "Function". NOTE: When specifying a System Variable, be sure to surround in single quotes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UpdateValueText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>UpdateValueText</maml:name> <maml:description> <maml:para>Specifies the Update Value 'value' for the specified attribute. NOTE: When specifying a System Variable, be sure to surround in single quotes.</maml: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 containing attribute 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UpdateValueType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>UpdateValueType</maml:name> <maml:description> <maml:para>Specifies the Update Value type for the specified attribute.</maml:para> <maml:para>Acceptable values: "None", "Fixed", "Select", "System variable", "Function". NOTE: When specifying a System Variable, be sure to surround in single quotes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UpdateValueText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>UpdateValueText</maml:name> <maml:description> <maml:para>Specifies the Update Value 'value' for the specified attribute. NOTE: When specifying a System Variable, be sure to surround in single quotes.</maml: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> <dev:code>Example usage for setting an attribute's Default Value settings values. Sets Type to fixed and value to TEST. Set-PWAttributeUpdateValueSettings -EnvironmentName 'Complex' -AttributeName 'Title3' -UpdateValueType "System variable" -UpdateValueText '$ENV.NAME$' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWAttributeUpdateValueTriggerAttribute --> <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-PWAttributeUpdateValueTriggerAttribute</command:name> <command:verb>Add</command:verb> <command:noun>PWAttributeUpdateValueTriggerAttribute</command:noun> <maml:description> <maml:para>Add-PWAttributeUpdateValueTriggerAttribute adds an attribute(s) to be used to trigger an attribute update within the specified environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add-PWAttributeUpdateValueTriggerAttribute adds an attribute(s) to be used to trigger an attribute update.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-PWAttributeUpdateValueTriggerAttribute</maml:name> <!-- Parameter: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment containing attribute 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AttributeNameToTriggerUpdate --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>AttributeNameToTriggerUpdate</maml:name> <maml:description> <maml:para>Specifies the attribute to be used to trigger an 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> </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 containing attribute 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AttributeNameToTriggerUpdate --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>AttributeNameToTriggerUpdate</maml:name> <maml:description> <maml:para>Specifies the attribute to be used to trigger an 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> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Example usage for adding one attribute to trigger an attribute update. Add-PWAttributeUpdateValueTriggerAttribute -EnvironmentName 'Complex' -AttributeName 'Title4' -AttributeNameToTriggerUpdate "Title1" -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Example usage for adding multiple attributes to trigger an attribute update. Add-PWAttributeUpdateValueTriggerAttribute -EnvironmentName 'Complex' -AttributeName 'Title4' -AttributeNameToTriggerUpdate "Title2", "Title3" -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWAttributeUpdateValueTriggerAttribute --> <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-PWAttributeUpdateValueTriggerAttribute</command:name> <command:verb>Get</command:verb> <command:noun>PWAttributeUpdateValueTriggerAttribute</command:noun> <maml:description> <maml:para>Get-PWAttributeUpdateValueTriggerAttribute returns all triggering attribute(s) for an attribute.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-PWAttributeUpdateValueTriggerAttribute returns all triggering attribute(s) for an attribute.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWAttributeUpdateValueTriggerAttribute</maml:name> <!-- Parameter: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment containing attribute to get information 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</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: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment containing attribute to get information 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</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> <dev:code>Example usage for getting the triggering attribute(s) for an attribute. Get-PWAttributeUpdateValueTriggerAttribute -EnvironmentName 'Complex' -AttributeName 'Title4' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWAttributeUpdateValueTriggerAttribute --> <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-PWAttributeUpdateValueTriggerAttribute</command:name> <command:verb>Remove</command:verb> <command:noun>PWAttributeUpdateValueTriggerAttribute</command:noun> <maml:description> <maml:para>Remove-PWAttributeUpdateValueTriggerAttribute removes a triggering attribute(s) from an attribute.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove-PWAttributeUpdateValueTriggerAttribute removes a triggering attribute(s) from an attribute. NOTE: If all triggering attributes are removed, the Update Value type will be set to none.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-PWAttributeUpdateValueTriggerAttribute</maml:name> <!-- Parameter: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment containing attribute 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TriggeringAttributeNameToRemove --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>TriggeringAttributeNameToRemove</maml:name> <maml:description> <maml:para>Specifies the triggering attribute(s) 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: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment containing attribute 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TriggeringAttributeNameToRemove --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>TriggeringAttributeNameToRemove</maml:name> <maml:description> <maml:para>Specifies the triggering attribute(s) 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> <dev:code>Example usage for removing one triggering attribute. Remove-PWAttributeUpdateValueTriggerAttribute -EnvironmentName 'Complex' -AttributeName 'Title4' -TriggeringAttributeNameToRemove "Title1" -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Example usage for removing multiple trigger attributes. Remove-PWAttributeUpdateValueTriggerAttribute -EnvironmentName 'Complex' -AttributeName 'Title4' -TriggeringAttributeNameToRemove "Title2", "Title3" -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWAttributeValueListFixedList --> <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-PWAttributeValueListFixedList</command:name> <command:verb>Get</command:verb> <command:noun>PWAttributeValueListFixedList</command:noun> <maml:description> <maml:para>Get-PWAttributeValueListFixedList returns all of the items within an attribute's Value settings fixed list.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-PWAttributeValueListFixedList returns all of the items within an attribute's Value settings fixed list.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWAttributeValueListFixedList</maml:name> <!-- Parameter: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment containing attribute to get view list fixed list 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</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: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment containing attribute to get view list fixed list 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</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> <dev:code>Example usage for getting an attribute's fixed list values. Get-PWAttributeValueListFixedList -EnvironmentName 'Complex' -AttributeName 'Title3' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWAttributeValueListSettings --> <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-PWAttributeValueListSettings</command:name> <command:verb>Set</command:verb> <command:noun>PWAttributeValueListSettings</command:noun> <maml:description> <maml:para>Set-PWAttributeValueListSettings updates an attribute's Value list settings within a specified environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-PWAttributeValueListSettings updates an attribute's Value list settings within a specified environment. The available settings are Value List Type and Values, Limit to list, and Multiple selection.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWAttributeValueListSettings</maml:name> <!-- Parameter: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment containing attribute 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ValueType</maml:name> <maml:description> <maml:para>Specifies the Value type for the specified attribute.</maml:para> <maml:para>Acceptable values: "None", "Fixed", "Select", "Function".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the Value list 'value' for the specified attribute. For Fixed Lists, separate the Value and Description by a semi-colon.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LimitToList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>LimitToList</maml:name> <maml:description> <maml:para>Toggles on/off the Limit to list option.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MultipleSelection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>MultipleSelection</maml:name> <maml:description> <maml:para>Toggles on/off the Multiple selection option.</maml: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 containing attribute 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>AttributeName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ValueType</maml:name> <maml:description> <maml:para>Specifies the Value type for the specified attribute.</maml:para> <maml:para>Acceptable values: "None", "Fixed", "Select", "Function".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the Value list 'value' for the specified attribute. For Fixed Lists, separate the Value and Description by a semi-colon.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LimitToList --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>LimitToList</maml:name> <maml:description> <maml:para>Toggles on/off the Limit to list option.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MultipleSelection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>MultipleSelection</maml:name> <maml:description> <maml:para>Toggles on/off the Multiple selection option.</maml: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> <dev:code>Example usage for setting an attribute's Value list settings. Sets Type to fixed and value to TEST. Set-PWAttributeValueSettings -EnvironmentName 'Complex' -AttributeName 'Title3' -ValueType Fixed -Value "TEST" -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Example usage for setting an attribute's Value list settings. Toggles on Limit to list and Multiple selection. Set-PWAttributeEditingSettings -EnvironmentName 'Complex' -AttributeName 'Title2' -LimitToList "On" -MultipleSelection "On" -Verbose</dev:code> </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> <maml:description> <maml:para>Get-PWAuditTrailSettings retrieves the audit trail settings for the current ProjectWise datasource.</maml:para> </maml:description> </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> <dev:code>Example usage for getting Audit Trail data. Get-PWAuditTrailSettings Returns all audit trail settings for current datasource.</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Example usage for getting only the project/folder Audit Trail data. Get-PWAuditTrailSettings -AuditTrailType 'project' Returns only the project/folder audit trail settings for current datasource.</dev:code> </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: Export-PWAuditTrailToSQLite --> <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-PWAuditTrailToSQLite</command:name> <command:verb>Export</command:verb> <command:noun>PWAuditTrailToSQLite</command:noun> <maml:description> <maml:para>Export audit trail records to a SQLite database for time-series graph display. If table or database does not exist, it will be created.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Export audit trail records to a SQLite database for time-series graph display. If table or database does not exist, it will be created.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: OutputFile --> <command:syntaxItem> <maml:name>Export-PWAuditTrailToSQLite</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 new or existing SQLite database.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StartDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Defaults to yesterday if not provided.</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>10/26/2020 5:11:19 PM</dev:defaultValue> </command:parameter> <!-- Parameter: EndDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>EndDate</maml:name> <maml:description> <maml:para>Defaults to now if not provided.</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>10/27/2020 5:11:19 PM</dev:defaultValue> </command:parameter> <!-- Parameter: TableName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Defaults to AuditTail 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> <dev:defaultValue>AuditTrail</dev:defaultValue> </command:parameter> <!-- Parameter: SkipSecondary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>SkipSecondary</maml:name> <maml:description> <maml:para>Exclude backup audit trail table.</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: IncludeFullObjectNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>IncludeFullObjectNames</maml:name> <maml:description> <maml:para>Include full object names (takes longer and not necessary for graph).</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 new or existing SQLite database.</maml:para> </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="false" globbing="false" pipelineInput="false" position="3"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Defaults to AuditTail 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> <dev:defaultValue>AuditTrail</dev:defaultValue> </command:parameter> <!-- Parameter: StartDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Defaults to yesterday if not provided.</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>10/26/2020 5:11:19 PM</dev:defaultValue> </command:parameter> <!-- Parameter: EndDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>EndDate</maml:name> <maml:description> <maml:para>Defaults to now if not provided.</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>10/27/2020 5:11:19 PM</dev:defaultValue> </command:parameter> <!-- Parameter: SkipSecondary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>SkipSecondary</maml:name> <maml:description> <maml:para>Exclude backup audit trail table.</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: IncludeFullObjectNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>IncludeFullObjectNames</maml:name> <maml:description> <maml:para>Include full object names (takes longer and not necessary for graph).</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> <dev:code>Expot-PWAuditTrailToSQLite c:\temp\audit.sqlite -StartDate 2010-01-01</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWCmdletStatistics --> <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-PWCmdletStatistics</command:name> <command:verb>Get</command:verb> <command:noun>PWCmdletStatistics</command:noun> <maml:description> <maml:para>Get the global usage statistics for a cmdlet.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: CmdletName --> <command:syntaxItem> <maml:name>Get-PWCmdletStatistics</maml:name> <!-- Parameter: CmdletName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>CmdletName</maml:name> <maml:description> <maml:para>Cmdlet name to report on. Supports asterisk wildcard. Omit to see data for all cmdlets.</maml: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: CmdletName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>CmdletName</maml:name> <maml:description> <maml:para>Cmdlet name to report on. Supports asterisk wildcard. Omit to see data for all cmdlets.</maml: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> <dev:code>Get-PWCmdletStatistics Get-PWDocumentsBySearch</dev:code> </command:example> </command:examples> </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>Create a new CONNECTED Project and optionally associate with a ProjectWise rich project.</maml:para> </maml:description> </command:details> <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. Connected projects will be added to these folders</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: WSGURL --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="10"> <maml:name>WSGURL</maml:name> <maml:description> <maml:para>WSG URL like https://decide-pwce-us-ws.bentley.com/ws. Include if you want to link back to the current ProjectWise 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: WSGVersion --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="11"> <maml:name>WSGVersion</maml:name> <maml:description> <maml:para>WSG Version (default 2.5)</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BaseURL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="12"> <maml:name>BaseURL</maml:name> <maml:description> <maml:para>Base URL (defaults to https://connect-wsg20.bentley.com). Used to find data center locations.</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></dev:defaultValue> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="13"> <maml:name>Token</maml:name> <maml:description> <maml:para>Token from Get-PWConnectionClientToken or Get-PWNonFederatedLoginToken -CreateWebToken.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DoNotEnableDeliverablesManagement --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>DoNotEnableDeliverablesManagement</maml:name> <maml:description> <maml:para>Set this to create a project without DM enabled.</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: InternalMembersOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="15"> <maml:name>InternalMembersOnly</maml:name> <maml:description> <maml:para>Set this to create a project which excludes external members.</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: EnableInsights --> <command:parameter required="false" globbing="false" pipelineInput="false" position="16"> <maml:name>EnableInsights</maml:name> <maml:description> <maml:para>Set this to enable the web side of Project Insights.</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: RecreateConnectedProject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="17"> <maml:name>RecreateConnectedProject</maml:name> <maml:description> <maml:para>Set this to enable the web side of Project Insights.</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: 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:para>Possible values: Airports, HydroElectricFacilities, SurfaceMines, TelecommunicationsNetworks, Tunnels, WastewaterCollectionNetworks, WastewaterTreatmentPlants, WaterDistributionNetworks, WaterTreatmentPlants, InstitutionalBuildings, CommunicationsTowers, NuclearPowerPlants, Factories, OffshoreStructures, ElectricalDistributionNetworks, OilRefineries, Pipelines, UndergroundMines, PortsAndTerminals, GasProcessingPlant, ProcessManufacturingPlant, RailNetworks, CombinedHeatAndPowerPlants, RenewableEnergyFacilities, StationsAndPlatforms, SportsFacilities, Roads, StormwaterNetworks, Substations, Bridges, CommercialBuildings, DataCenters, DefenseFacilities, DistrictEnergyNetworks, EducationalFacilities, ElectricTransmissionNetworks, FiberNetworks, FossilFuelPlant, GasDistributionNetworks, HealthercareFacilities, HybridFiberCoaxNetworks, Other</maml:para> </maml:description> <command:parameterValue required="true">AssetTypes</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.AddPWConnectedProject+AssetTypes</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Other</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Airports</command:parameterValue> <command:parameterValue required="false" variableLength="false">HydroElectricFacilities</command:parameterValue> <command:parameterValue required="false" variableLength="false">SurfaceMines</command:parameterValue> <command:parameterValue required="false" variableLength="false">TelecommunicationsNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tunnels</command:parameterValue> <command:parameterValue required="false" variableLength="false">WastewaterCollectionNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">WastewaterTreatmentPlants</command:parameterValue> <command:parameterValue required="false" variableLength="false">WaterDistributionNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">WaterTreatmentPlants</command:parameterValue> <command:parameterValue required="false" variableLength="false">InstitutionalBuildings</command:parameterValue> <command:parameterValue required="false" variableLength="false">CommunicationsTowers</command:parameterValue> <command:parameterValue required="false" variableLength="false">NuclearPowerPlants</command:parameterValue> <command:parameterValue required="false" variableLength="false">Factories</command:parameterValue> <command:parameterValue required="false" variableLength="false">OffshoreStructures</command:parameterValue> <command:parameterValue required="false" variableLength="false">ElectricalDistributionNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">OilRefineries</command:parameterValue> <command:parameterValue required="false" variableLength="false">Pipelines</command:parameterValue> <command:parameterValue required="false" variableLength="false">UndergroundMines</command:parameterValue> <command:parameterValue required="false" variableLength="false">PortsAndTerminals</command:parameterValue> <command:parameterValue required="false" variableLength="false">GasProcessingPlant</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProcessManufacturingPlant</command:parameterValue> <command:parameterValue required="false" variableLength="false">RailNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">CombinedHeatAndPowerPlants</command:parameterValue> <command:parameterValue required="false" variableLength="false">RenewableEnergyFacilities</command:parameterValue> <command:parameterValue required="false" variableLength="false">StationsAndPlatforms</command:parameterValue> <command:parameterValue required="false" variableLength="false">SportsFacilities</command:parameterValue> <command:parameterValue required="false" variableLength="false">Roads</command:parameterValue> <command:parameterValue required="false" variableLength="false">StormwaterNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">Substations</command:parameterValue> <command:parameterValue required="false" variableLength="false">Bridges</command:parameterValue> <command:parameterValue required="false" variableLength="false">CommercialBuildings</command:parameterValue> <command:parameterValue required="false" variableLength="false">DataCenters</command:parameterValue> <command:parameterValue required="false" variableLength="false">DefenseFacilities</command:parameterValue> <command:parameterValue required="false" variableLength="false">DistrictEnergyNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">EducationalFacilities</command:parameterValue> <command:parameterValue required="false" variableLength="false">ElectricTransmissionNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">FiberNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">FossilFuelPlant</command:parameterValue> <command:parameterValue required="false" variableLength="false">GasDistributionNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">HealthercareFacilities</command:parameterValue> <command:parameterValue required="false" variableLength="false">HybridFiberCoaxNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">Other</command:parameterValue> </command:parameterValueGroup> </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:para>Possible values: BuildingsAndFacilities, Communications, DiscreteManufacturing, ElectricAndGasUtilities, MappingAndSurveying, Mining, OilAndGas, PowerGeneration, ProcessManufacturing, RailAndTransit, RoadsAndHighways, WaterAndWastewater, Other</maml:para> </maml:description> <command:parameterValue required="true">Industries</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.AddPWConnectedProject+Industries</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Other</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BuildingsAndFacilities</command:parameterValue> <command:parameterValue required="false" variableLength="false">Communications</command:parameterValue> <command:parameterValue required="false" variableLength="false">DiscreteManufacturing</command:parameterValue> <command:parameterValue required="false" variableLength="false">ElectricAndGasUtilities</command:parameterValue> <command:parameterValue required="false" variableLength="false">MappingAndSurveying</command:parameterValue> <command:parameterValue required="false" variableLength="false">Mining</command:parameterValue> <command:parameterValue required="false" variableLength="false">OilAndGas</command:parameterValue> <command:parameterValue required="false" variableLength="false">PowerGeneration</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProcessManufacturing</command:parameterValue> <command:parameterValue required="false" variableLength="false">RailAndTransit</command:parameterValue> <command:parameterValue required="false" variableLength="false">RoadsAndHighways</command:parameterValue> <command:parameterValue required="false" variableLength="false">WaterAndWastewater</command:parameterValue> <command:parameterValue required="false" variableLength="false">Other</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CountryCode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>CountryCode</maml:name> <maml:description> <maml:para>Country Code for project. Defaults to US.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DataLocation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>DataLocation</maml:name> <maml:description> <maml:para>Data Location for project. Defaults to East US if blank.</maml:para> </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>Obsolete.</maml:para> </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="8"> <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: ConnectedProjectPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</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. Connected projects will be added to these folders</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:para>Possible values: Airports, HydroElectricFacilities, SurfaceMines, TelecommunicationsNetworks, Tunnels, WastewaterCollectionNetworks, WastewaterTreatmentPlants, WaterDistributionNetworks, WaterTreatmentPlants, InstitutionalBuildings, CommunicationsTowers, NuclearPowerPlants, Factories, OffshoreStructures, ElectricalDistributionNetworks, OilRefineries, Pipelines, UndergroundMines, PortsAndTerminals, GasProcessingPlant, ProcessManufacturingPlant, RailNetworks, CombinedHeatAndPowerPlants, RenewableEnergyFacilities, StationsAndPlatforms, SportsFacilities, Roads, StormwaterNetworks, Substations, Bridges, CommercialBuildings, DataCenters, DefenseFacilities, DistrictEnergyNetworks, EducationalFacilities, ElectricTransmissionNetworks, FiberNetworks, FossilFuelPlant, GasDistributionNetworks, HealthercareFacilities, HybridFiberCoaxNetworks, Other</maml:para> </maml:description> <command:parameterValue required="true">AssetTypes</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.AddPWConnectedProject+AssetTypes</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Other</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Airports</command:parameterValue> <command:parameterValue required="false" variableLength="false">HydroElectricFacilities</command:parameterValue> <command:parameterValue required="false" variableLength="false">SurfaceMines</command:parameterValue> <command:parameterValue required="false" variableLength="false">TelecommunicationsNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">Tunnels</command:parameterValue> <command:parameterValue required="false" variableLength="false">WastewaterCollectionNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">WastewaterTreatmentPlants</command:parameterValue> <command:parameterValue required="false" variableLength="false">WaterDistributionNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">WaterTreatmentPlants</command:parameterValue> <command:parameterValue required="false" variableLength="false">InstitutionalBuildings</command:parameterValue> <command:parameterValue required="false" variableLength="false">CommunicationsTowers</command:parameterValue> <command:parameterValue required="false" variableLength="false">NuclearPowerPlants</command:parameterValue> <command:parameterValue required="false" variableLength="false">Factories</command:parameterValue> <command:parameterValue required="false" variableLength="false">OffshoreStructures</command:parameterValue> <command:parameterValue required="false" variableLength="false">ElectricalDistributionNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">OilRefineries</command:parameterValue> <command:parameterValue required="false" variableLength="false">Pipelines</command:parameterValue> <command:parameterValue required="false" variableLength="false">UndergroundMines</command:parameterValue> <command:parameterValue required="false" variableLength="false">PortsAndTerminals</command:parameterValue> <command:parameterValue required="false" variableLength="false">GasProcessingPlant</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProcessManufacturingPlant</command:parameterValue> <command:parameterValue required="false" variableLength="false">RailNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">CombinedHeatAndPowerPlants</command:parameterValue> <command:parameterValue required="false" variableLength="false">RenewableEnergyFacilities</command:parameterValue> <command:parameterValue required="false" variableLength="false">StationsAndPlatforms</command:parameterValue> <command:parameterValue required="false" variableLength="false">SportsFacilities</command:parameterValue> <command:parameterValue required="false" variableLength="false">Roads</command:parameterValue> <command:parameterValue required="false" variableLength="false">StormwaterNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">Substations</command:parameterValue> <command:parameterValue required="false" variableLength="false">Bridges</command:parameterValue> <command:parameterValue required="false" variableLength="false">CommercialBuildings</command:parameterValue> <command:parameterValue required="false" variableLength="false">DataCenters</command:parameterValue> <command:parameterValue required="false" variableLength="false">DefenseFacilities</command:parameterValue> <command:parameterValue required="false" variableLength="false">DistrictEnergyNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">EducationalFacilities</command:parameterValue> <command:parameterValue required="false" variableLength="false">ElectricTransmissionNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">FiberNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">FossilFuelPlant</command:parameterValue> <command:parameterValue required="false" variableLength="false">GasDistributionNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">HealthercareFacilities</command:parameterValue> <command:parameterValue required="false" variableLength="false">HybridFiberCoaxNetworks</command:parameterValue> <command:parameterValue required="false" variableLength="false">Other</command:parameterValue> </command:parameterValueGroup> </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:para>Possible values: BuildingsAndFacilities, Communications, DiscreteManufacturing, ElectricAndGasUtilities, MappingAndSurveying, Mining, OilAndGas, PowerGeneration, ProcessManufacturing, RailAndTransit, RoadsAndHighways, WaterAndWastewater, Other</maml:para> </maml:description> <command:parameterValue required="true">Industries</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.AddPWConnectedProject+Industries</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Other</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">BuildingsAndFacilities</command:parameterValue> <command:parameterValue required="false" variableLength="false">Communications</command:parameterValue> <command:parameterValue required="false" variableLength="false">DiscreteManufacturing</command:parameterValue> <command:parameterValue required="false" variableLength="false">ElectricAndGasUtilities</command:parameterValue> <command:parameterValue required="false" variableLength="false">MappingAndSurveying</command:parameterValue> <command:parameterValue required="false" variableLength="false">Mining</command:parameterValue> <command:parameterValue required="false" variableLength="false">OilAndGas</command:parameterValue> <command:parameterValue required="false" variableLength="false">PowerGeneration</command:parameterValue> <command:parameterValue required="false" variableLength="false">ProcessManufacturing</command:parameterValue> <command:parameterValue required="false" variableLength="false">RailAndTransit</command:parameterValue> <command:parameterValue required="false" variableLength="false">RoadsAndHighways</command:parameterValue> <command:parameterValue required="false" variableLength="false">WaterAndWastewater</command:parameterValue> <command:parameterValue required="false" variableLength="false">Other</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: CountryCode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>CountryCode</maml:name> <maml:description> <maml:para>Country Code for project. Defaults to US.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DataLocation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>DataLocation</maml:name> <maml:description> <maml:para>Data Location for project. Defaults to East US if blank.</maml:para> </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="8"> <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="8"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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>Obsolete.</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: WSGURL --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="10"> <maml:name>WSGURL</maml:name> <maml:description> <maml:para>WSG URL like https://decide-pwce-us-ws.bentley.com/ws. Include if you want to link back to the current ProjectWise 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: WSGVersion --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="11"> <maml:name>WSGVersion</maml:name> <maml:description> <maml:para>WSG Version (default 2.5)</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BaseURL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="12"> <maml:name>BaseURL</maml:name> <maml:description> <maml:para>Base URL (defaults to https://connect-wsg20.bentley.com). Used to find data center locations.</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></dev:defaultValue> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="13"> <maml:name>Token</maml:name> <maml:description> <maml:para>Token from Get-PWConnectionClientToken or Get-PWNonFederatedLoginToken -CreateWebToken.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DoNotEnableDeliverablesManagement --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>DoNotEnableDeliverablesManagement</maml:name> <maml:description> <maml:para>Set this to create a project without DM enabled.</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: InternalMembersOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="15"> <maml:name>InternalMembersOnly</maml:name> <maml:description> <maml:para>Set this to create a project which excludes external members.</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: EnableInsights --> <command:parameter required="false" globbing="false" pipelineInput="false" position="16"> <maml:name>EnableInsights</maml:name> <maml:description> <maml:para>Set this to enable the web side of Project Insights.</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: RecreateConnectedProject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="17"> <maml:name>RecreateConnectedProject</maml:name> <maml:description> <maml:para>Set this to enable the web side of Project Insights.</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 ProjectWise folders from pipeline. Connected projects will be added to these folders</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>WSG URL like https://decide-pwce-us-ws.bentley.com/ws. Include if you want to link back to the current ProjectWise Project.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>WSG Version (default 2.5)</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Create new rich projects and add connected projects to them. $token = Get-PWConnectionClientToken $suffixes = "31","32","33","34","35" foreach ($suffix in $suffixes){ $rp2=New-PWRichProject -NewFolderPath "_Testing Connected 03\Project $suffix" -DoNotCopyDocuments -TemplateName 'Civil' -StorageArea Storage -UpgradeIfExists Add-PWConnectedProject -InputFolder $rp2 -ConnectedProjectName "Alpha Bravo Charlie $suffix" -ConnectedProjectNumber "AlphaBravoCharlieDelta$suffix" -Location 'Durham, NC' -AssetType 'Airport' -WSGURL 'https://decide-pwce-us-ws.bentley.com/ws' -Token $token }</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-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>Get-PWConnectedProject</command:name> <command:verb>Get</command:verb> <command:noun>PWConnectedProject</command:noun> <maml:description> <maml:para>Gets CONNECTED project from a rich project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes an array of ProjectWiseFolders and returns connected project objects.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWConnectedProject</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> <!-- Parameter: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="2"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Token</maml:name> <maml:description> <maml:para>Pass base 64 encoded token from Get-PWConnectionClientToken (do not use -UseRelyingParty) or from Get-PWNonFederatedLoginToken -CreateWebToken.</maml: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 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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="2"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Token</maml:name> <maml:description> <maml:para>Pass base 64 encoded token from Get-PWConnectionClientToken (do not use -UseRelyingParty) or from Get-PWNonFederatedLoginToken -CreateWebToken.</maml: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 ProjectWise folders from pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for getting the CONNECTED project for each rich project in a tree. New-PWLogin Server:DSN #Get all the rich projects in this tree and pipe to this cmdlet $rps = Get-PWRichProjects -FolderPath "PWPS Connected Project Test 6\Projects 2" #foreach rich project, get the Connected Project ID foreach ($rp in $rps) { write-host $rp Get-PWConnectedProject $rp }</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-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>Remove-PWConnectedProject</command:name> <command:verb>Remove</command:verb> <command:noun>PWConnectedProject</command:noun> <maml:description> <maml:para>Remove CONNECTED Project and CONNECTED Project Association.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Remove-PWConnectedProject</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> <!-- Parameter: ClearAssociation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ClearAssociation</maml:name> <maml:description> <maml:para>Clear the CONNECTED project assocation even if the Connected Project delete fails.</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: PreserveConnectedProject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>PreserveConnectedProject</maml:name> <maml:description> <maml:para>Don't delete the CONNECTED Project, just clear association.</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="3"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Not 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: ConnectedProjectPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Not used.</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: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="5"> <maml:name>Token</maml:name> <maml:description> <maml:para>CONNECT Token.</maml: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 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: ClearAssociation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ClearAssociation</maml:name> <maml:description> <maml:para>Clear the CONNECTED project assocation even if the Connected Project delete fails.</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: PreserveConnectedProject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>PreserveConnectedProject</maml:name> <maml:description> <maml:para>Don't delete the CONNECTED Project, just clear association.</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="3"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Not 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: ConnectedProjectPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Not used.</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: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="5"> <maml:name>Token</maml:name> <maml:description> <maml:para>CONNECT Token.</maml: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 ProjectWise folders from pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Create new rich projects and add connected projects to them. $rps=Get-PWRichProject -FolderPath (Show-PWFolderBrowserDialog).FullPath Remove-PWConnectedProject $rps -ClearAssociation </dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWConnectedProjectAssetTypes --> <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-PWConnectedProjectAssetTypes</command:name> <command:verb>Get</command:verb> <command:noun>PWConnectedProjectAssetTypes</command:noun> <maml:description> <maml:para>Get Connected Project Industry Types.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWConnectedProjectAssetTypes</maml:name> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>To be used in place of username/password.</maml:para> </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="1"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="2"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</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: IndustryType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>IndustryType</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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>To be used in place of username/password.</maml:para> </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="1"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="2"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</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: IndustryType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>IndustryType</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> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Remove-PWConnectedProjectAssociation --> <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-PWConnectedProjectAssociation</command:name> <command:verb>Remove</command:verb> <command:noun>PWConnectedProjectAssociation</command:noun> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Remove-PWConnectedProjectAssociation</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 folder object to remove the CONNECTed Project Association from.</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> </command:syntaxItem> <!-- Parameter set: GUID --> <command:syntaxItem> <maml:name>Remove-PWConnectedProjectAssociation</maml:name> <!-- Parameter: FolderGUID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>FolderGUID</maml:name> <maml:description> <maml:para>The Project Guid for the Work Area to remove the CONNECTed Project Association 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> </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 folder object to remove the CONNECTed Project Association from.</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: FolderGUID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>FolderGUID</maml:name> <maml:description> <maml:para>The Project Guid for the Work Area to remove the CONNECTed Project Association 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> </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 folder object to remove the CONNECTed Project Association from.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The Project Guid for the Work Area to remove the CONNECTed Project Association from.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Set-PWConnectedProjectAssociation --> <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-PWConnectedProjectAssociation</command:name> <command:verb>Set</command:verb> <command:noun>PWConnectedProjectAssociation</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWConnectedProjectAssociation</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 folder object to set the CONNECTed Project Association for.</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: ConnectedProjectGUID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ConnectedProjectGUID</maml:name> <maml:description> <maml:para>The CONNECTed Project Guid to associate with the Work 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: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>The folder object to set the CONNECTed Project Association for.</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: ConnectedProjectGUID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ConnectedProjectGUID</maml:name> <maml:description> <maml:para>The CONNECTed Project Guid to associate with the Work 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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The folder object to set the CONNECTed Project Association for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-PWConnectedProjectDataLocations --> <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-PWConnectedProjectDataLocations</command:name> <command:verb>Get</command:verb> <command:noun>PWConnectedProjectDataLocations</command:noun> <maml:description> <maml:para>Get a list of possible CONNECTED Project data center locations.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWConnectedProjectDataLocations</maml:name> <!-- Parameter: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="1"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</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: BaseURL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>BaseURL</maml:name> <maml:description> <maml:para>Base URL (defaults to https://connect-wsg20.bentley.com)</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></dev:defaultValue> </command:parameter> <!-- Parameter: WSGVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>WSGVersion</maml:name> <maml:description> <maml:para>WSG Version (defaults to sv1.0, whatever that means)</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>sv1.0</dev:defaultValue> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>Token</maml:name> <maml:description> <maml:para>Token generated from Get-PWConnectionClientToken or Get-PWDMServiceAccountToken</maml: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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="1"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</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: BaseURL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>BaseURL</maml:name> <maml:description> <maml:para>Base URL (defaults to https://connect-wsg20.bentley.com)</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></dev:defaultValue> </command:parameter> <!-- Parameter: WSGVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>WSGVersion</maml:name> <maml:description> <maml:para>WSG Version (defaults to sv1.0, whatever that means)</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>sv1.0</dev:defaultValue> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>Token</maml:name> <maml:description> <maml:para>Token generated from Get-PWConnectionClientToken or Get-PWDMServiceAccountToken</maml: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: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> <dev:code>#Example usage for getting the CONNECTED project id for each rich project in a tree. New-PWLogin Server:DSN #Get all the rich projects in this tree and pipe to this cmdlet $rps = Get-PWRichProjects -FolderPath "PWPS Connected Project Test 6\Projects 2" #foreach rich project, get the Connected Project ID foreach ($rp in $rps) { write-host $rp Get-PWConnectedProjectId $rp }</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWConnectedProjectIndustryTypes --> <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-PWConnectedProjectIndustryTypes</command:name> <command:verb>Get</command:verb> <command:noun>PWConnectedProjectIndustryTypes</command:noun> <maml:description> <maml:para>Get Connected Project Industry Types.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWConnectedProjectIndustryTypes</maml:name> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>To be used in place of username/password.</maml:para> </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="1"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="2"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</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: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>To be used in place of username/password.</maml:para> </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="1"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="2"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</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:command> <!-- Cmdlet: Get-PWConnectedProjectRoles --> <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-PWConnectedProjectRoles</command:name> <command:verb>Get</command:verb> <command:noun>PWConnectedProjectRoles</command:noun> <maml:description> <maml:para>Gets the roles in a projects.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: ConnectedProjectId --> <command:syntaxItem> <maml:name>Get-PWConnectedProjectRoles</maml:name> <!-- Parameter: ConnectedProjectId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>Connected Project ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Token</maml:name> <maml:description> <maml:para>Pass token to use for connection.</maml: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: ConnectedProjectId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>Connected Project ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Token</maml:name> <maml:description> <maml:para>Pass token to use for connection.</maml: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>Connected Project ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for adding users to roles in a CONNECTED project. Get-PWConnectedProjectRoles "6b477bc8-cb00-47d2-a158-eccc8efcdc2d" -Token (Get-PWConnectionClientToken)</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Copy-PWConnectedProjectSettings --> <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-PWConnectedProjectSettings</command:name> <command:verb>Copy</command:verb> <command:noun>PWConnectedProjectSettings</command:noun> <maml:description> <maml:para>Copy settings from one CONNECTED project to another.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: TargetFolders --> <command:syntaxItem> <maml:name>Copy-PWConnectedProjectSettings</maml:name> <!-- Parameter: TargetFolders --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>TargetFolders</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: SourceRichProjectPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SourceRichProjectPath</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: SourceProjectId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SourceProjectId</maml:name> <maml:description> <maml:para>Will use current CONNECT client session if not set.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="5"> <maml:name>Token</maml:name> <maml:description> <maml:para>Pass base 64 encoded token from Get-PWConnectionClientToken (do not use -UseRelyingParty) or from Get-PWNonFederatedLoginToken -CreateWebToken.</maml: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: TargetFolders --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>TargetFolders</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: SourceRichProjectPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SourceRichProjectPath</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: SourceProjectId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SourceProjectId</maml:name> <maml:description> <maml:para>Will use current CONNECT client session if not set.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="5"> <maml:name>Token</maml:name> <maml:description> <maml:para>Pass base 64 encoded token from Get-PWConnectionClientToken (do not use -UseRelyingParty) or from Get-PWNonFederatedLoginToken -CreateWebToken.</maml: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 ProjectWise folders from pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Get all the rich projects in a tree and pipe to this cmdlet with a folder path to the source rich project (and inferred Connected Project) Get-PWRichProjects -FolderPath 'Connected 03\Projects' | Copy-PWConnectedProjectSettings -SourceRichProjectPath 'Connected\Project 01' #Use connected project id to identify source Connected Project $connectedId = Get-PWRichProjects -FolderPath '_Testing Connected\Project 02' | Get-PWConnectedProjectId Get-PWRichProjects -FolderPath '_Testing Connected 03' | Copy-PWConnectedProjectSettings -SourceProjectId $connectedId</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWConnectedProjectUsersToRoles --> <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-PWConnectedProjectUsersToRoles</command:name> <command:verb>Add</command:verb> <command:noun>PWConnectedProjectUsersToRoles</command:noun> <maml:description> <maml:para>Adds all the defined users in a project to the given roles. Validates the roles before adding.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: ConnectedProjectId --> <command:syntaxItem> <maml:name>Add-PWConnectedProjectUsersToRoles</maml:name> <!-- Parameter: ConnectedProjectId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>Connected Project ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Roles --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Roles</maml:name> <maml:description> <maml:para>Array of roles.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Token</maml:name> <maml:description> <maml:para>Pass token to use for connection.</maml: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: ConnectedProjectId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>Connected Project ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Roles --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Roles</maml:name> <maml:description> <maml:para>Array of roles.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Token</maml:name> <maml:description> <maml:para>Pass token to use for connection.</maml: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>Connected Project ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for adding users to roles in a CONNECTED project. Add-PWConnectedProjectUsersToRoles "6b477bc8-cb00-47d2-a158-eccc8efcdc2d" -Roles "Project Administrator",""Photogrammetrist" -Token (Get-PWConnectionClientToken)</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWConnectedUserCount --> <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-PWConnectedUserCount</command:name> <command:verb>Get</command:verb> <command:noun>PWConnectedUserCount</command:noun> <maml:description> <maml:para>Return count of connected users.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWConnectedUserCount</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWConnectedUserList --> <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-PWConnectedUserList</command:name> <command:verb>Get</command:verb> <command:noun>PWConnectedUserList</command:noun> <maml:description> <maml:para>Return count of connected users.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWConnectedUserList</maml:name> <!-- Parameter: LastLogin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <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: LastLogin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <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> <dev:code>Get-PWConnectedUserCount</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWConnectionClientToken --> <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-PWConnectionClientToken</command:name> <command:verb>Get</command:verb> <command:noun>PWConnectionClientToken</command:noun> <maml:description> <maml:para>Gets Token from Connection client to use with other CONNECT APIs with Invoke-RestMethod.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWConnectionClientToken</maml:name> <!-- Parameter: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="1"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</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: UsePWRelyingParty --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UsePWRelyingParty</maml:name> <maml:description> <maml:para>Add relying party sso://pw-integration-server/1016 to token.</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: CreatePWDIToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>CreatePWDIToken</maml:name> <maml:description> <maml:para>Add relying party sso://pw-integration-server/1016 to token.</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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="1"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</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: UsePWRelyingParty --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UsePWRelyingParty</maml:name> <maml:description> <maml:para>Add relying party sso://pw-integration-server/1016 to token.</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: CreatePWDIToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>CreatePWDIToken</maml:name> <maml:description> <maml:para>Add relying party sso://pw-integration-server/1016 to token.</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-PWConnectorToken --> <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-PWConnectorToken</command:name> <command:verb>Get</command:verb> <command:noun>PWConnectorToken</command:noun> <maml:description> <maml:para>Get a tokenized credential for use with the ProjectWise Connector.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWConnectorToken</maml:name> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <maml:description> <maml:para>User 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: Password --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password in secure string (Required).</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: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</maml:name> <maml:description> <maml:para>User 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: Password --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password in secure string (Required).</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> <dev:code>$encryptedPassword = Read-Host -Prompt "Enter Password:" -AsSecureString $token = Get-PWConnectorToken -UserName "user.name" -Password $encryptedPassword</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWConnectURL --> <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-PWConnectURL</command:name> <command:verb>Get</command:verb> <command:noun>PWConnectURL</command:noun> <maml:description> <maml:para>Get the named URL from the global registry (BUDDI).</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Name --> <command:syntaxItem> <maml:name>Get-PWConnectURL</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Pass a name like 'ProjectShare.URL' or 'CONNECTEDContextService.URL' or 'RepositoryFederationService.URL' or 'BTSSvc.URL'.</maml: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>Pass a name like 'ProjectShare.URL' or 'CONNECTEDContextService.URL' or 'RepositoryFederationService.URL' or 'BTSSvc.URL'.</maml: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>Pass a name like 'ProjectShare.URL' or 'CONNECTEDContextService.URL' or 'RepositoryFederationService.URL' or 'BTSSvc.URL'.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWConnectURL ProjectShare.Url</dev:code> </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> <dev:code>#Example usage for getting current datasource name. Import-Module pwps_dab Get-PWCurrentDatasource</dev:code> </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> <dev:code>#Example usage for populating a variable with the current datasource session information. $session = Get-PWCurrentDSSession</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWCurrentUser --> <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-PWCurrentUser</command:name> <command:verb>Get</command:verb> <command:noun>PWCurrentUser</command:noun> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> </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> <dev:code>Get-PWCustomNumericSetting -SettingID -1789</dev:code> </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> <dev:code>Set-PWCustomNumericSetting -SettingID -1789 -Value 10</dev:code> </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> <dev:code>Get-PWCustomStringSetting -SettingID -1776</dev:code> </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> <dev:code>Set-PWCustomStringSetting -SettingID -1776 -Value "We hold these truths..."</dev:code> </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> <dev:code>#Get datasource global unique identifier Get-PWDatasourceGuid</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Show-PWDatasources --> <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-PWDatasources</command:name> <command:verb>Show</command:verb> <command:noun>PWDatasources</command:noun> <maml:description> <maml:para>Get a list of the datasources.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ds = Show-PWDatasources</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-PWDataTableValues --> <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-PWDataTableValues</command:name> <command:verb>Import</command:verb> <command:noun>PWDataTableValues</command:noun> <maml:description> <maml:para>Write the values from a datatable into a table in the PW database for lookup table maintenance.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputTables --> <command:syntaxItem> <maml:name>Import-PWDataTableValues</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: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Table name to insert values into.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValuesFormat --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ValuesFormat</maml:name> <maml:description> <maml:para>Values format. Will be similar to "'{0}','{1}',{2},{3}" should match the number of columns in the datatable</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClearValues --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ClearValues</maml:name> <maml:description> <maml:para>Remove rows first.</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: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Table name to insert values into.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValuesFormat --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ValuesFormat</maml:name> <maml:description> <maml:para>Values format. Will be similar to "'{0}','{1}',{2},{3}" should match the number of columns in the datatable</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClearValues --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ClearValues</maml:name> <maml:description> <maml:para>Remove rows first.</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> <dev:code>$datatable = Select-PWSQLDataTable 'select * from t_lookup_location' New-XLSXWorkbook $datatable -OutputFileName C:\temp\t_lookup_location.xlsx #edit spreadsheet and put data back $datatableFromXLSX = Get-TablesFromXLSXWorkbook -InputFileName C:\temp\t_lookup_location.xlsx Import-PWDataTableValues $datatableFromXLSX -TableName t_lookup_location -ValuesFormat "'{0}','{1}','{2}','{3}',{4},'{5}'" -ClearValues</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWDefaultConnectionClientUser --> <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-PWDefaultConnectionClientUser</command:name> <command:verb>Get</command:verb> <command:noun>PWDefaultConnectionClientUser</command:noun> <maml:description> <maml:para>Get default Connection Client user</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Get-PWDgnFileVersion --> <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-PWDgnFileVersion</command:name> <command:verb>Get</command:verb> <command:noun>PWDgnFileVersion</command:noun> <maml:description> <maml:para>Copies out DGN and reports on V7 or V8 file format.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Get-PWDgnFileVersion</maml:name> <!-- Parameter: InputDocuments --> <command:parameter required="false" 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: LeaveCopy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>LeaveCopy</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: InputDocuments --> <command:parameter required="false" 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: LeaveCopy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>LeaveCopy</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> <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> <dev:code>$docs = $docs=Get-PWDocumentsBySearch -FolderPath (Show-PWFolderBrowserDialog).FullPath -FileName %.dgn Get-PWDgnFileVersion $docs</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWDgnMimeType --> <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-PWDgnMimeType</command:name> <command:verb>Set</command:verb> <command:noun>PWDgnMimeType</command:noun> <maml:description> <maml:para>Copies out DGN and sets appropriate MIME Type for V7 or V8 file formats.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Set-PWDgnMimeType</maml:name> <!-- Parameter: InputDocuments --> <command:parameter required="false" 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: LeaveCopy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>LeaveCopy</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: InputDocuments --> <command:parameter required="false" 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: LeaveCopy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>LeaveCopy</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> <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> <dev:code>$docs = $docs=Get-PWDocumentsBySearch -FolderPath (Show-PWFolderBrowserDialog).FullPath -FileName %.dgn Set-PWDgnMimeType $docs</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWDMIncomingRFIs --> <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-PWDMIncomingRFIs</command:name> <command:verb>Get</command:verb> <command:noun>PWDMIncomingRFIs</command:noun> <maml:description> <maml:para>Generates a list containing all Incoming RFIs in the CONNECTed project associated with the rich projects passed in.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Generates a list containing all Incoming RFIs in the CONNECTed project associated with the rich projects passed in.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolders --> <command:syntaxItem> <maml:name>Get-PWDMIncomingRFIs</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 ProjectWise folders from pipeline. These folders will be included in report if they are rich projects and have CONNECTed projects.</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: ConnectedProjectId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ConnectedProjectId</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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Not 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: ConnectedProjectPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Not 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: Company --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Company</maml:name> <maml:description> <maml:para>If set, will filter RFIs by Company.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IssuerEmail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>IssuerEmail</maml:name> <maml:description> <maml:para>If set, will filter RFIs by Issuer 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: UseCheckProject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>UseCheckProject</maml:name> <maml:description> <maml:para>If set, will use CheckProject instead of GetProjectByBCKey.</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: ConnectToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="7"> <maml:name>ConnectToken</maml:name> <maml:description> <maml:para>Connect token to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReceivedSince --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>ReceivedSince</maml:name> <maml:description> <maml:para>Received since date. Defaults to Jan 1, 2015.</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>01/01/2015 12:00:00 AM</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 ProjectWise folders from pipeline. These folders will be included in report if they are rich projects and have CONNECTed projects.</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: ConnectedProjectId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ConnectedProjectId</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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Not 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: ConnectedProjectPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Not 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: Company --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Company</maml:name> <maml:description> <maml:para>If set, will filter RFIs by Company.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IssuerEmail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>IssuerEmail</maml:name> <maml:description> <maml:para>If set, will filter RFIs by Issuer 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: UseCheckProject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>UseCheckProject</maml:name> <maml:description> <maml:para>If set, will use CheckProject instead of GetProjectByBCKey.</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: ConnectToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="7"> <maml:name>ConnectToken</maml:name> <maml:description> <maml:para>Connect token to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReceivedSince --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>ReceivedSince</maml:name> <maml:description> <maml:para>Received since date. Defaults to Jan 1, 2015.</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>01/01/2015 12:00:00 AM</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. These folders will be included in report if they are rich projects and have CONNECTed projects.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for reporting on incoming RFIs for CONNECTED projects. $rps=Get-PWRichProjects GetPWDMIncomingRFIs $rps</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Save-PWDMIncomingRFIs --> <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-PWDMIncomingRFIs</command:name> <command:verb>Save</command:verb> <command:noun>PWDMIncomingRFIs</command:noun> <maml:description> <maml:para>Downloads incoming RFI files.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Downloads incoming RFI files.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: RFIs --> <command:syntaxItem> <maml:name>Save-PWDMIncomingRFIs</maml:name> <!-- Parameter: RFIs --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>RFIs</maml:name> <maml:description> <maml:para>Transmittals to download.</maml:para> </maml:description> <command:parameterValue required="true">IncomingRFIList[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.ConnectedProjectAdapter+IncomingRFIList[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.ConnectedProjectAdapter+IncomingRFIList[]</dev:defaultValue> </command:parameter> <!-- Parameter: OutputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>OutputFolder</maml:name> <maml:description> <maml:para>Output 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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="true (ByValue)" position="3"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>Token</maml:name> <maml:description> <maml:para>Obsolete.</maml: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: RFIs --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>RFIs</maml:name> <maml:description> <maml:para>Transmittals to download.</maml:para> </maml:description> <command:parameterValue required="true">IncomingRFIList[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.ConnectedProjectAdapter+IncomingRFIList[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.ConnectedProjectAdapter+IncomingRFIList[]</dev:defaultValue> </command:parameter> <!-- Parameter: OutputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>OutputFolder</maml:name> <maml:description> <maml:para>Output 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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="true (ByValue)" position="3"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>Token</maml:name> <maml:description> <maml:para>Obsolete.</maml: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.ConnectedProjectAdapter+IncomingRFIList[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Transmittals to download.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Output folder.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for downloading all submittals for a datasource. $rps=Get-PWRichProjects Get-PWDMIncomingRFIs $rps | Save-PWDMIncomingRFIs -OutputFolder d:\rfis</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWDMIncomingRFIsWithProperties --> <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-PWDMIncomingRFIsWithProperties</command:name> <command:verb>Get</command:verb> <command:noun>PWDMIncomingRFIsWithProperties</command:noun> <maml:description> <maml:para>Generates a list containing all Incoming RFIs in the rich project's CONNECTed project issued since the given date.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Generates a list containing all Incoming RFIs in the rich project's CONNECTed project issued since the given date.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ConnectedProjectId --> <command:syntaxItem> <maml:name>Get-PWDMIncomingRFIsWithProperties</maml:name> <!-- Parameter: ConnectedProjectId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>Project ID to query.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectToken --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ConnectToken</maml:name> <maml:description> <maml:para>Service Account Token.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IssuedSince --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>IssuedSince</maml:name> <maml:description> <maml:para>Date since which RFI was issued.</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>01/01/2015 12:00:00 AM</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ConnectedProjectId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>Project ID to query.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectToken --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ConnectToken</maml:name> <maml:description> <maml:para>Service Account Token.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IssuedSince --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>IssuedSince</maml:name> <maml:description> <maml:para>Date since which RFI was issued.</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>01/01/2015 12:00:00 AM</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>Project ID to query.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Service Account Token.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Date since which RFI was issued.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$folder = Get-PWFolderByURN 'pw://decide-pwce-us.bentley.com:decide-pwce-us-10/Documents/P{c654ea13-d144-4053-99d4-41f092399e56}/' $webToken = Get-PWNonFederatedLoginToken -UserName dave.brumbaugh@eagle.bentley.com -Password (ConvertTo-SecureString xxx -AsPlainText -Force) -CreateWebToken Get-PWDMIncomingRFIsWithProperties -ConnectedProjectId $folder.ConnectedProjectId -ConnectToken $webToken -IssuedSince '2018-01-01'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Save-PWDMIncomingSubmittal --> <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-PWDMIncomingSubmittal</command:name> <command:verb>Save</command:verb> <command:noun>PWDMIncomingSubmittal</command:noun> <maml:description> <maml:para>Downloads incoming submittals packages.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Downloads incoming submittals packages.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Submittals --> <command:syntaxItem> <maml:name>Save-PWDMIncomingSubmittal</maml:name> <!-- Parameter: Submittals --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Submittals</maml:name> <maml:description> <maml:para>Transmittals to download.</maml:para> </maml:description> <command:parameterValue required="true">PWDMIncomingSubmittal[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWDMIncomingSubmittal[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.PWDMIncomingSubmittal[]</dev:defaultValue> </command:parameter> <!-- Parameter: ConnectedProjectId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>CONNECTED project id.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PackageId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>PackageId</maml:name> <maml:description> <maml:para>ID of package to download.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>OutputFolder</maml:name> <maml:description> <maml:para>Output 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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="true (ByValue)" position="5"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="6"> <maml:name>Token</maml:name> <maml:description> <maml:para>CONNECT Token.</maml: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: Submittals --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Submittals</maml:name> <maml:description> <maml:para>Transmittals to download.</maml:para> </maml:description> <command:parameterValue required="true">PWDMIncomingSubmittal[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWDMIncomingSubmittal[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.PWDMIncomingSubmittal[]</dev:defaultValue> </command:parameter> <!-- Parameter: ConnectedProjectId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>CONNECTED project id.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PackageId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>PackageId</maml:name> <maml:description> <maml:para>ID of package to download.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>OutputFolder</maml:name> <maml:description> <maml:para>Output 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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="true (ByValue)" position="5"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="6"> <maml:name>Token</maml:name> <maml:description> <maml:para>CONNECT Token.</maml: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.PWDMIncomingSubmittal[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Transmittals to download.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>CONNECTED project id.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>ID of package to download.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Output folder.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for downloading all submittals for a datasource. $rps=Get-PWRichProjects Get-PWDMIncomingSubmittals $rps | Save-PWDMIncomingSubmittal -OutputFolder d:\submittals</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWDMIncomingSubmittals --> <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-PWDMIncomingSubmittals</command:name> <command:verb>Get</command:verb> <command:noun>PWDMIncomingSubmittals</command:noun> <maml:description> <maml:para>Generates a list containing all Incoming Submittals in the CONNECTed project associated with the rich projects passed in.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Generates a list containing all Incoming Submittals in the CONNECTed project associated with the rich projects passed in.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolders --> <command:syntaxItem> <maml:name>Get-PWDMIncomingSubmittals</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 ProjectWise folders from pipeline. These folders will be included in report if they are rich projects and have CONNECTed projects.</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: ConnectedProjectId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ConnectedProjectId</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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="3"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DataTable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DataTable</maml:name> <maml:description> <maml:para>Output DataTable.</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: UseCheckProject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>UseCheckProject</maml:name> <maml:description> <maml:para>Use CheckProject API.</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: ConnectToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="6"> <maml:name>ConnectToken</maml:name> <maml:description> <maml:para>Connect token.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReceivedSince --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ReceivedSince</maml:name> <maml:description> <maml:para>Received since date. Defaults to Jan 1, 2015.</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>01/01/2015 12:00:00 AM</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 ProjectWise folders from pipeline. These folders will be included in report if they are rich projects and have CONNECTed projects.</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: ConnectedProjectId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ConnectedProjectId</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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="3"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DataTable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DataTable</maml:name> <maml:description> <maml:para>Output DataTable.</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: UseCheckProject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>UseCheckProject</maml:name> <maml:description> <maml:para>Use CheckProject API.</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: ConnectToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="6"> <maml:name>ConnectToken</maml:name> <maml:description> <maml:para>Connect token.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReceivedSince --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ReceivedSince</maml:name> <maml:description> <maml:para>Received since date. Defaults to Jan 1, 2015.</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>01/01/2015 12:00:00 AM</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. These folders will be included in report if they are rich projects and have CONNECTed projects.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for reporting on incoming submittals for CONNECTED projects. $rps=Get-PWRichProjects GetPWDMIncomingSubmittals $rps</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWDMOutgoingRFIs --> <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-PWDMOutgoingRFIs</command:name> <command:verb>Get</command:verb> <command:noun>PWDMOutgoingRFIs</command:noun> <maml:description> <maml:para>Generates a list containing all Outgoing RFIs in the CONNECTed project associated with the rich projects passed in.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Generates a list containing all Outgoing RFIs in the CONNECTed project associated with the rich projects passed in.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolders --> <command:syntaxItem> <maml:name>Get-PWDMOutgoingRFIs</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 ProjectWise folders from pipeline. These folders will be included in report if they are rich projects and have CONNECTed projects.</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: ConnectedProjectId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ConnectedProjectId</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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Not 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: ConnectedProjectPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Not 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: RecipientEmail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>RecipientEmail</maml:name> <maml:description> <maml:para>If set, will filter RFIs by Recipient 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: UseCheckProject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>UseCheckProject</maml:name> <maml:description> <maml:para>If set, will use CheckProject instead of GetProjectByBCKey.</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: ConnectToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="6"> <maml:name>ConnectToken</maml:name> <maml:description> <maml:para>Connect Token.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ModifiedSince --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ModifiedSince</maml:name> <maml:description> <maml:para>Modified since date. Defaults to Jan 1, 2015.</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>01/01/2015 12:00:00 AM</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 ProjectWise folders from pipeline. These folders will be included in report if they are rich projects and have CONNECTed projects.</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: ConnectedProjectId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ConnectedProjectId</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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Not 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: ConnectedProjectPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Not 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: RecipientEmail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>RecipientEmail</maml:name> <maml:description> <maml:para>If set, will filter RFIs by Recipient 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: UseCheckProject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>UseCheckProject</maml:name> <maml:description> <maml:para>If set, will use CheckProject instead of GetProjectByBCKey.</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: ConnectToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="6"> <maml:name>ConnectToken</maml:name> <maml:description> <maml:para>Connect Token.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ModifiedSince --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ModifiedSince</maml:name> <maml:description> <maml:para>Modified since date. Defaults to Jan 1, 2015.</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>01/01/2015 12:00:00 AM</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. These folders will be included in report if they are rich projects and have CONNECTed projects.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for reporting on Outgoing RFIs for CONNECTED projects. $rps=Get-PWRichProjects GetPWDMOutgoingRFIs $rps</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Save-PWDMOutgoingRFIs --> <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-PWDMOutgoingRFIs</command:name> <command:verb>Save</command:verb> <command:noun>PWDMOutgoingRFIs</command:noun> <maml:description> <maml:para>Downloads Outgoing RFI files.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Downloads Outgoing RFI files.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: RFIs --> <command:syntaxItem> <maml:name>Save-PWDMOutgoingRFIs</maml:name> <!-- Parameter: RFIs --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>RFIs</maml:name> <maml:description> <maml:para>Transmittals to download.</maml:para> </maml:description> <command:parameterValue required="true">OutgoingRFIList[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.ConnectedProjectAdapter+OutgoingRFIList[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.ConnectedProjectAdapter+OutgoingRFIList[]</dev:defaultValue> </command:parameter> <!-- Parameter: OutputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>OutputFolder</maml:name> <maml:description> <maml:para>Output 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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="true (ByValue)" position="3"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>Token</maml:name> <maml:description> <maml:para>CONNECT Token.</maml: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: RFIs --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>RFIs</maml:name> <maml:description> <maml:para>Transmittals to download.</maml:para> </maml:description> <command:parameterValue required="true">OutgoingRFIList[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.ConnectedProjectAdapter+OutgoingRFIList[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.ConnectedProjectAdapter+OutgoingRFIList[]</dev:defaultValue> </command:parameter> <!-- Parameter: OutputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>OutputFolder</maml:name> <maml:description> <maml:para>Output 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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="true (ByValue)" position="3"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>Token</maml:name> <maml:description> <maml:para>CONNECT Token.</maml: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.ConnectedProjectAdapter+OutgoingRFIList[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Transmittals to download.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Output folder.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for downloading all Outgoing RFIs for a datasource. $rps=Get-PWRichProjects Get-PWDMOutgoingRFIs $rps | Save-PWDMOutgoingRFIs -OutputFolder d:\rfis</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Save-PWDMOutgoingTransmittal --> <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-PWDMOutgoingTransmittal</command:name> <command:verb>Save</command:verb> <command:noun>PWDMOutgoingTransmittal</command:noun> <maml:description> <maml:para>Downloads outgoing transmittals packages.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Downloads outgoing transmittals packages.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Transmittals --> <command:syntaxItem> <maml:name>Save-PWDMOutgoingTransmittal</maml:name> <!-- Parameter: Transmittals --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Transmittals</maml:name> <maml:description> <maml:para>Transmittals to download.</maml:para> </maml:description> <command:parameterValue required="true">PWDMIncomingSubmittal[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWDMIncomingSubmittal[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.PWDMIncomingSubmittal[]</dev:defaultValue> </command:parameter> <!-- Parameter: ConnectedProjectId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>CONNECTED project id.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PackageId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>PackageId</maml:name> <maml:description> <maml:para>ID of package to download.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>OutputFolder</maml:name> <maml:description> <maml:para>Output 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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="true (ByValue)" position="5"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="6"> <maml:name>Token</maml:name> <maml:description> <maml:para>Obsolete.</maml: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: Transmittals --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Transmittals</maml:name> <maml:description> <maml:para>Transmittals to download.</maml:para> </maml:description> <command:parameterValue required="true">PWDMIncomingSubmittal[]</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.PWDMIncomingSubmittal[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWPS_DAB.PWDMIncomingSubmittal[]</dev:defaultValue> </command:parameter> <!-- Parameter: ConnectedProjectId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>CONNECTED project id.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PackageId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>PackageId</maml:name> <maml:description> <maml:para>ID of package to download.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>OutputFolder</maml:name> <maml:description> <maml:para>Output 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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="true (ByValue)" position="5"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="6"> <maml:name>Token</maml:name> <maml:description> <maml:para>Obsolete.</maml: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.PWDMIncomingSubmittal[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Transmittals to download.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>CONNECTED project id.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>ID of package to download.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Output folder.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for downloading all transmittals for a datasource. $rps=Get-PWRichProjects Get-PWDMOutgoingTransmittals $rps | Save-PWDMOutgoingTransmittal -OutputFolder d:\transmittals</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWDMOutgoingTransmittals --> <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-PWDMOutgoingTransmittals</command:name> <command:verb>Get</command:verb> <command:noun>PWDMOutgoingTransmittals</command:noun> <maml:description> <maml:para>Generates a list containing all Outgoing Transmittals in the CONNECTed project associated with the rich projects passed in.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Generates a list containing all Outgoing Transmittals in the CONNECTed project associated with the rich projects passed in.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolders --> <command:syntaxItem> <maml:name>Get-PWDMOutgoingTransmittals</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 ProjectWise folders from pipeline. These folders will be included in report if they are rich projects and have CONNECTed projects.</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: ConnectedProjectId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ConnectedProjectId</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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="3"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DataTable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DataTable</maml:name> <maml:description> <maml:para>Output DataTable.</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: UseCheckProject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>UseCheckProject</maml:name> <maml:description> <maml:para>Use Check Project API.</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: ConnectToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="6"> <maml:name>ConnectToken</maml:name> <maml:description> <maml:para>Connect Token.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ModifiedSince --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ModifiedSince</maml:name> <maml:description> <maml:para>Modified Since. Defaults to Jan 1, 2015.</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>01/01/2015 12:00:00 AM</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 ProjectWise folders from pipeline. These folders will be included in report if they are rich projects and have CONNECTed projects.</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: ConnectedProjectId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ConnectedProjectId</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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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="3"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DataTable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DataTable</maml:name> <maml:description> <maml:para>Output DataTable.</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: UseCheckProject --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>UseCheckProject</maml:name> <maml:description> <maml:para>Use Check Project API.</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: ConnectToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="6"> <maml:name>ConnectToken</maml:name> <maml:description> <maml:para>Connect Token.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ModifiedSince --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ModifiedSince</maml:name> <maml:description> <maml:para>Modified Since. Defaults to Jan 1, 2015.</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>01/01/2015 12:00:00 AM</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. These folders will be included in report if they are rich projects and have CONNECTed projects.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for reporting on outgoing transmittals for CONNECTED projects. $rps=Get-PWRichProjects GetPWDMOutgoingTransmittals $rps</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWDMServiceAccountToken --> <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-PWDMServiceAccountToken</command:name> <command:verb>Get</command:verb> <command:noun>PWDMServiceAccountToken</command:noun> <maml:description> <maml:para>Gets a service account token if available. Only certain accounts can have this.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWDMServiceAccountToken</maml:name> <!-- Parameter: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <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="1"> <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> <!-- Parameter: CreateWebToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>CreateWebToken</maml:name> <maml:description> <maml:para>Get Token for CONNECT.</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: AppliesTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>AppliesTo</maml:name> <maml:description> <maml:para>Arbitrary "Applies To" address for future use.</maml: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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <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="1"> <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> <!-- Parameter: CreateWebToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>CreateWebToken</maml:name> <maml:description> <maml:para>Get Token for CONNECT.</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: AppliesTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>AppliesTo</maml:name> <maml:description> <maml:para>Arbitrary "Applies To" address for future use.</maml: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: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="false" 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: IssueTransmittal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>IssueTransmittal</maml:name> <maml:description> <maml:para>Only used if CONNECT client session is not established.</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: ConnectToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="11"> <maml:name>ConnectToken</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: 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="false" 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> <!-- Parameter: IssueTransmittal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>IssueTransmittal</maml:name> <maml:description> <maml:para>Only used if CONNECT client session is not established.</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: ConnectToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="11"> <maml:name>ConnectToken</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> </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> <dev:code>$connectedProjectGuid = Get-PWFolders -FolderPath "Rich Project From PowerShell\Project 03" -JustOne | Get-PWConnectedProjectId $docs = Get-PWDocumentsBySearch -FolderPath "Rich Project From PowerShell\Project 03" -FileName Merged.pdf 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</dev:code> </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> <maml:description> <maml:para>Copy-PWDocument copies input document from path specification or from input document object to TargetFolderPath with optional new document name and/or filename.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Copies input document with optional renaming.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Document --> <command:syntaxItem> <maml:name>Copy-PWDocument</maml:name> <!-- Parameter: InputDocument --> <command:parameter required="false" 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: SourceDocumentNamePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SourceDocumentNamePath</maml:name> <maml:description> <maml:para>Full path to document to copy.</maml:para> </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="2"> <maml:name>TargetFolderPath</maml:name> <maml:description> <maml:para>Folder name to copy 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: NewDocumentName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>NewDocumentName</maml:name> <maml:description> <maml:para>New document name (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: NewFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>NewFileName</maml:name> <maml:description> <maml:para>New document file name (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: CreateVersions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateVersions</maml:name> <maml:description> <maml:para>Create version if target document name/file already exists (Optional).</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: DoNotCopyReferenceRelations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotCopyReferenceRelations</maml:name> <maml:description> <maml:para>Will copy reference relationships if this switch is 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputDocument --> <command:parameter required="false" 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: SourceDocumentNamePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SourceDocumentNamePath</maml:name> <maml:description> <maml:para>Full path to document to copy.</maml:para> </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="2"> <maml:name>TargetFolderPath</maml:name> <maml:description> <maml:para>Folder name to copy 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: NewDocumentName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>NewDocumentName</maml:name> <maml:description> <maml:para>New document name (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: NewFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>NewFileName</maml:name> <maml:description> <maml:para>New document file name (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: CreateVersions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateVersions</maml:name> <maml:description> <maml:para>Create version if target document name/file already exists (Optional).</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: DoNotCopyReferenceRelations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotCopyReferenceRelations</maml:name> <maml:description> <maml:para>Will copy reference relationships if this switch is 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> </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> <dev:code>Renames the ProjectWise document passed via the pipeline to 'A111-View-4_Renamed.dwg'. Only the document name is changed. Get-PWDocumentsBySearch -FolderPath 'TEST\New' -JustThisFolder -DocumentName 'A111-View-4.dwg' -Verbose | Rename-PWDocument -DocumentNewName 'A111-View-4_Renamed.dwg' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Renames the ProjectWise document passed via the pipeline to 'A111-View-4_Renamed.dwg'. Both the document and file name are changed. Get-PWDocumentsBySearch -FolderPath 'TEST\New' -JustThisFolder -DocumentName 'A111-View-4.dwg' -Verbose | Rename-PWDocument -DocumentNewName 'A111-View-4_Renamed.dwg' -RenameFile -Verbose</dev:code> </command:example> </command:examples> </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: 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> <!-- Parameter: Application --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Application</maml:name> <maml:description> <maml:para>Application Name to use (optional). Will use default application for file extension if not supplied.</maml:para> </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 use. FileName used if not supplied.</maml: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: FolderPath --> <command:syntaxItem> <maml:name>New-PWDocument</maml:name> <!-- 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> <!-- Parameter: Application --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Application</maml:name> <maml:description> <maml:para>Application Name to use (optional). Will use default application for file extension if not supplied.</maml:para> </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 use. FileName used if not supplied.</maml: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> <!-- Parameter: Application --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Application</maml:name> <maml:description> <maml:para>Application Name to use (optional). Will use default application for file extension if not supplied.</maml:para> </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 use. FileName used if not supplied.</maml: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> <dev:code>#Example usage getting folders and creating new documents. New-PWLogin Server:DSN #Get the folder for folder number 20315 and create a new document there Get-PWFolders 20315 | New-PWDocument -FilePath c:\temp\NewDrawing.dgn #Get the folder at the given folder path and create a document there Get-PWFolders -FolderPath 'Level 1\Level 2\Level 3\Level 4' -JustOne | New-PWDocument -FilePath c:\temp\NewDrawing.dgn -Description 'Drawing 1' #Create a new folder at the given folder path and create a document there New-PWFolder -FolderPath 'PowerShell Demo\Level 2\Level 3\Level 4' -StorageArea Storage01 | New-PWDocument -FilePath c:\temp\NewDrawing.dgn -Description 'Drawing 1' #Create a new document in existing folder New-PWDocument -FolderPath 'Demo\Folder 1' -FilePath c:\temp\NewDrawing.dgn -Description 'Drawing 1'</dev:code> </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> <maml:description> <maml:para>Rename-PWDocument renames the provided document object with the provided new document name. If the RenameFile switch parameter is included, the file name will be updated as well.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Rename-PWDocument renames the provided document object with the provided new document name. If the RenameFile switch parameter is included, the file name will be updated as well.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Rename-PWDocument</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: DocumentNewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <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> <!-- Parameter: RenameFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RenameFile</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: DocumentNewName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <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> <!-- Parameter: RenameFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RenameFile</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> <dev:code>Renames the ProjectWise document passed via the pipeline to 'A111-View-4_Renamed.dwg'. Only the document name is changed. Get-PWDocumentsBySearch -FolderPath 'TEST\New' -JustThisFolder -DocumentName 'A111-View-4.dwg' -Verbose | Rename-PWDocument -DocumentNewName 'A111-View-4_Renamed.dwg' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Renames the ProjectWise document passed via the pipeline to 'A111-View-4_Renamed.dwg'. Both the document and file name are changed. Get-PWDocumentsBySearch -FolderPath 'TEST\New' -JustThisFolder -DocumentName 'A111-View-4.dwg' -Verbose | Rename-PWDocument -DocumentNewName 'A111-View-4_Renamed.dwg' -RenameFile -Verbose</dev:code> </command:example> </command:examples> </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> <maml:description> <maml:para>Given a folder object or folder path, create one or more abstract documents without attributes. When the DoNotAddSuffix parameter is included, the 5 digit serial number will not be placed at the end of the document name and only one document will be added to each folder regardless of the count entered.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolders --> <command:syntaxItem> <maml:name>New-PWDocumentAbstract</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> <!-- 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: DoNotAddSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotAddSuffix</maml:name> <maml:description> <maml:para>When included, the 5 digit serial number suffix will not be added to the document name and only one document will be added to each folder regardless of the count entered.</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> <!-- Parameter set: FolderPath --> <command:syntaxItem> <maml:name>New-PWDocumentAbstract</maml:name> <!-- 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: FolderPath --> <command:parameter required="true" 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: 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: DoNotAddSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotAddSuffix</maml:name> <maml:description> <maml:para>When included, the 5 digit serial number suffix will not be added to the document name and only one document will be added to each folder regardless of the count entered.</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="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> <!-- Parameter: FolderPath --> <command:parameter required="true" 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> <!-- Parameter: DoNotAddSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotAddSuffix</maml:name> <maml:description> <maml:para>When included, the 5 digit serial number suffix will not be added to the document name and only one document will be added to each folder regardless of the count entered.</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>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> <dev:code>#Example usage getting folders and creating new documents. # 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 New-PWDocumentAbstract -FolderPath 'Level 1\' -DocumentName 'doc' -Description 'Abstract Document' New-PWDocumentAbstract -FolderPath 'Level 1\' -DocumentName 'AbstractDoc' -Count 2</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code># 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 Get-PWFolders -FolderPath 'Level 1\Level 2\Level 3\Level 4' -JustOne | New-PWDocumentAbstract -DocumentName 'doc' Get-PWFolders -FolderPath 'Level 1\' | New-PWDocumentAbstract -DocumentName 'AbstractDoc' -Count 3</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>The following example will create one document within each folder without adding the 5 digit serial number suffix. Get-PWFolders -FolderPath 'Level 1' | New-PWDocumentAbstract -DocumentName 'doc' -DoNotAddSuffix</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWDocumentApplication --> <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-PWDocumentApplication</command:name> <command:verb>Set</command:verb> <command:noun>PWDocumentApplication</command:noun> <maml:description> <maml:para>Sets the application associated with a document.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes a document object from the pipeline and sets the associated application.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Set-PWDocumentApplication</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 like that 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: Application --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Application</maml:name> <maml:description> <maml:para>Name of application to associate with 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>Array of document objects like that 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: Application --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Application</maml:name> <maml:description> <maml:para>Name of application to associate with 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>Array of document objects like that from Get-PWDocumentsBySearch.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Sets the associated application to MicroStation for the specified documents. $docs = Show-PWDocumentSelectionDialog -FileExtension 'dgn' -Verbose Set-PWDocumentApplication -InputDocuments $docs -Application MicroStation -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Sets the associated application to MicroStation for the documents passed via the pipeline. $docs = Show-PWDocumentSelectionDialog -FileExtension 'dgn' -Verbose | Set-PWDocumentApplication -Application MicroStation -Verbose</dev:code> </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> <dev:code>#Get the documents in the given path and update them with the listed attributes Get-PWDocumentsBySearch -FolderPath 'Import\Test' | Update-PWDocumentAttributes -Attributes @{Title = "New Title"; Dwg_no = "007"; SomeNumber = "555" }</dev:code> </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: InputDocuments --> <command:syntaxItem> <maml:name>Get-PWDocumentAuditTrailRecords</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> </command:parameter> <!-- Parameter: OutputFilePathName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputFilePathName</maml:name> <maml:description> <maml:para>Provide file path and 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: OutputFormat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>HelpMessage = "If OutputFilePathName is provided, the OutputFormat is required. Specifies export type. Valid entries are Excel and SQLite."</maml:para> </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="true (ByValue)" position="named"> <maml:name>IncludeSecondary</maml:name> <maml:description> <maml:para>Included for legacy script support. Ignored.</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: SkipSecondary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipSecondary</maml:name> <maml:description> <maml:para>When the SkipSecondary switch parameter is included, only the document audit trail entries from dms_audt 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> <!-- Parameter set: NotFromPipeline --> <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: OutputFilePathName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputFilePathName</maml:name> <maml:description> <maml:para>Provide file path and 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: OutputFormat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>HelpMessage = "If OutputFilePathName is provided, the OutputFormat is required. Specifies export type. Valid entries are Excel and SQLite."</maml:para> </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="true (ByValue)" position="named"> <maml:name>IncludeSecondary</maml:name> <maml:description> <maml:para>Included for legacy script support. Ignored.</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: SkipSecondary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipSecondary</maml:name> <maml:description> <maml:para>When the SkipSecondary switch parameter is included, only the document audit trail entries from dms_audt 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: 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> </command:parameter> <!-- 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="true (ByValue)" position="named"> <maml:name>IncludeSecondary</maml:name> <maml:description> <maml:para>Included for legacy script support. Ignored.</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: SkipSecondary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipSecondary</maml:name> <maml:description> <maml:para>When the SkipSecondary switch parameter is included, only the document audit trail entries from dms_audt 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> <!-- Parameter: OutputFilePathName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputFilePathName</maml:name> <maml:description> <maml:para>Provide file path and 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: OutputFormat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>HelpMessage = "If OutputFilePathName is provided, the OutputFormat is required. Specifies export type. Valid entries are Excel and SQLite."</maml: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>Target document object(s) from pipeline.</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>Included for legacy script support. Ignored.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-PWDocumentByURN --> <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-PWDocumentByURN</command:name> <command:verb>Get</command:verb> <command:noun>PWDocumentByURN</command:noun> <maml:description> <maml:para>Get document object from URN address as copied from PW Explorer address bar.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get document object from URN address as copied from PW Explorer address bar.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: URN --> <command:syntaxItem> <maml:name>Get-PWDocumentByURN</maml:name> <!-- Parameter: URN --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>URN</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: URN --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>URN</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> <dev:code>$doc = Get-PWDocumentByURN "pw://decide-pwce-us.bentley.com:decide-pwce-us-10/Documents/D{7b39cd83-e8a1-4fce-8838-17c37a8ee158}"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWDocumentCaptionFromAI --> <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-PWDocumentCaptionFromAI</command:name> <command:verb>Get</command:verb> <command:noun>PWDocumentCaptionFromAI</command:noun> <maml:description> <maml:para>Use Microsoft Cognitive Services Computer Vision API to assign a description to a photo. Harnessing Artificial Intelligence for ProjectWise.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Get-PWDocumentCaptionFromAI</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: AttributeName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>AttributeName</maml:name> <maml:description> <maml:para>Put returned caption value in this attribute. (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: ReplaceDescription --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>ReplaceDescription</maml:name> <maml:description> <maml:para>Change document description to the returned caption value. (Optional).</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: MinimumConfidence --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>MinimumConfidence</maml:name> <maml:description> <maml:para>Will only update attribute or description if the confidence level is above this value (defaults to .70).</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.7</dev:defaultValue> </command:parameter> <!-- Parameter: Language --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>Language</maml:name> <maml:description> <maml:para>Will only update attribute or description if the confidence level is above this value (defaults to .70).</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>en</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: AttributeName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>AttributeName</maml:name> <maml:description> <maml:para>Put returned caption value in this attribute. (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: ReplaceDescription --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>ReplaceDescription</maml:name> <maml:description> <maml:para>Change document description to the returned caption value. (Optional).</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: MinimumConfidence --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>MinimumConfidence</maml:name> <maml:description> <maml:para>Will only update attribute or description if the confidence level is above this value (defaults to .70).</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.7</dev:defaultValue> </command:parameter> <!-- Parameter: Language --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>Language</maml:name> <maml:description> <maml:para>Will only update attribute or description if the confidence level is above this value (defaults to .70).</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>en</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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Put returned caption value in this attribute. (Optional).</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>Change document description to the returned caption value. (Optional).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Will only update attribute or description if the confidence level is above this value (defaults to .70).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Will only update attribute or description if the confidence level is above this value (defaults to .70).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWDocumentsBySearch -FolderPath 'A 01\Photos' | Get-PWDocumentCaptionFromAI -ReplaceDescription Get-PWDocumentsBySearch -FolderPath 'A 01\Photos' | Get-PWDocumentCaptionFromAI -AttributeName Caption -ReplaceDescription $docs = Get-PWDocumentsBySearch -FolderPath 'AMEC-FosterWheeler\Photos' Get-PWDocumentCaptionFromAI $docs -AttributeName Title -ReplaceDescription</dev:code> </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> </command:details> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>New-PWDocumentComment</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: 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> <!-- Parameter set: Folder --> <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: 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: 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: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:command> <!-- Cmdlet: Get-PWDocumentCopyOutLocationCounts --> <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-PWDocumentCopyOutLocationCounts</command:name> <command:verb>Get</command:verb> <command:noun>PWDocumentCopyOutLocationCounts</command:noun> <maml:description> <maml:para>Get the document checkout locations (for cleanup).</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWDocumentCopyOutLocationCounts</maml:name> <!-- Parameter: ByNode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ByNode</maml:name> <maml:description> <maml:para>Sort by node with the most copy out records instead of by user (default).</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: Before --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Before</maml:name> <maml:description> <maml:para>Filter for records with date before the given 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>05/05/1984 12:00:00 AM</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ByNode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ByNode</maml:name> <maml:description> <maml:para>Sort by node with the most copy out records instead of by user (default).</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: Before --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Before</maml:name> <maml:description> <maml:para>Filter for records with date before the given 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>05/05/1984 12:00:00 AM</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWDocumentCopyOutLocationCounts -ByNode -Before 2019-01-01</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWDocumentCopyOutLocations --> <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-PWDocumentCopyOutLocations</command:name> <command:verb>Remove</command:verb> <command:noun>PWDocumentCopyOutLocations</command:noun> <maml:description> <maml:para>Clean-up the document checkout locations (like chcklcleanup.exe).</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputUsers --> <command:syntaxItem> <maml:name>Remove-PWDocumentCopyOutLocations</maml:name> <!-- Parameter: InputUsers --> <command:parameter required="false" 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> <dev:defaultValue>Bentley.ProjectWise.PowerShell.Common.User[]</dev:defaultValue> </command:parameter> <!-- Parameter: Before --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Before</maml:name> <maml:description> <maml:para>Remove records with date before the given 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>05/05/1984 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: Nodes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Nodes</maml:name> <maml:description> <maml:para>Remove records for these nodes.</maml: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: InputUsers --> <command:parameter required="false" 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> <dev:defaultValue>Bentley.ProjectWise.PowerShell.Common.User[]</dev:defaultValue> </command:parameter> <!-- Parameter: Nodes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Nodes</maml:name> <maml:description> <maml:para>Remove records for these nodes.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Before --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Before</maml:name> <maml:description> <maml:para>Remove records with date before the given 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>05/05/1984 12:00:00 AM</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>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> <dev:code>$users = Get-PWUsersByMatch "*@bentley.com" Remove-PWDocumentCopyOutLocations $users -Before 2019-01-01 Remove-PWDocumentCopyOutLocations -Nodes "server1","server2","server3" -Before 2019-01-01</dev:code> </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> <maml:description> <maml:para>The Update-PWDocumentFile cmdlet offers a method to replace the associated physical file with file from the local system for a ProjectWise document. Documents need to be passed via the PowerShell pipeline as a ProjectWiseDocument type.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: NewFileName --> <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> </command:parameter> <!-- Parameter: NewFilePathName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewFilePathName</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: RemoveFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveFile</maml:name> <maml:description> <maml:para>If set, remove the existing file leaving the document as an abstract document.</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> <!-- Parameter set: KeepExistingFileName --> <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> </command:parameter> <!-- Parameter: NewFilePathName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewFilePathName</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: KeepExistingFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepExistingFileName</maml:name> <maml:description> <maml:para>When included, the existing file name will be used regardless of the name of the specified 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> <!-- Parameter: RemoveFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveFile</maml:name> <maml:description> <maml:para>If set, remove the existing file leaving the document as an abstract document.</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> </command:parameter> <!-- Parameter: NewFilePathName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewFilePathName</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: KeepExistingFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepExistingFileName</maml:name> <maml:description> <maml:para>When included, the existing file name will be used regardless of the name of the specified 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> <!-- Parameter: RemoveFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveFile</maml:name> <maml:description> <maml:para>If set, remove the existing file leaving the document as an abstract document.</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> <dev:code>#Example usage replacing physical file. The following will replace the existing file associated with the ProjectWise document(s) The file name of the specified file will be used. Get-PWDocumentsBySearch -FolderPath "Examples" -DocumentName "A111.dwg" -JustThisFolder -Verbose | Update-PWDocumentFile -NewFilePathName "D:\TEMP\Export\A111_Updated.dwg" -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Example usage replacing physical file and renaming using document name. The following will replace the existing file associated with the ProjectWise document(s) and rename using the new file name. Get-PWDocumentsBySearch -FolderPath "Examples" -DocumentName "A111.dwg" -JustThisFolder -Verbose | Update-PWDocumentFile -NewFilePathName "D:\TEMP\Export\A111_Updated.dwg" -NewFileName "A111_UpdatedFile.dwg" -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>#Example usage replacing physical file and renaming with specified new name. The following will replace the existing file associated with the ProjectWise document(s) and keep the original associated file name. Get-PWDocumentsBySearch -FolderPath "Examples" -DocumentName "A111.dwg" -JustThisFolder -Verbose | Update-PWDocumentFile -NewFilePathName "D:\TEMP\Export\A111_Updated.dwg" -KeepExistingFileName -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWDocumentFileFromProjectWise --> <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-PWDocumentFileFromProjectWise</command:name> <command:verb>Update</command:verb> <command:noun>PWDocumentFileFromProjectWise</command:noun> <maml:description> <maml:para>The Update-PWDocumentFileFromProjectWise cmdlet offers a method to replace the associated physical file with file from another document within the current ProjectWise datasource. Documents need to be passed via the PowerShell pipeline as a ProjectWiseDocument type.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-PWDocumentFileFromProjectWise</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> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder containing the document, whose file will be used to replace file with.</maml:para> </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="true" globbing="false" pipelineInput="false" position="2"> <maml:name>FileName</maml:name> <maml:description> <maml:para>File name of the source ProjectWise 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: KeepExistingFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepExistingFileName</maml:name> <maml:description> <maml:para>When included, the existing file name will be used regardless of the name of the specified 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> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder containing the document, whose file will be used to replace file with.</maml:para> </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="true" globbing="false" pipelineInput="false" position="2"> <maml:name>FileName</maml:name> <maml:description> <maml:para>File name of the source ProjectWise 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: KeepExistingFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeepExistingFileName</maml:name> <maml:description> <maml:para>When included, the existing file name will be used regardless of the name of the specified 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> <dev:code>#Example usage replacing physical file. The following will replace the existing file associated with the ProjectWise document(s). The existing file name will be replaced with the new file name. $pwDocuments = Get-PWDocumentsBySearch -FolderPath 'PowerShell\DocsToReplaceFile' -JustThisFolder | Update-PWDocumentFileFromProjectWise -FolderPath 'PowerShell\Docs' -FileName 'Cmdlets - LookupTables.pdf' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Example usage replacing physical file and renaming using document name. The following will replace the existing file associated with the ProjectWise document(s). The existing file name will be used. $pwDocuments = Get-PWDocumentsBySearch -FolderPath 'PowerShell\DocsToReplaceFile' -JustThisFolder | Update-PWDocumentFileFromProjectWise -FolderPath 'PowerShell\Docs' -FileName 'Cmdlets - LookupTables.pdf' -KeepExistingFileName -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Export-PWDocumentFilesToZip --> <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-PWDocumentFilesToZip</command:name> <command:verb>Export</command:verb> <command:noun>PWDocumentFilesToZip</command:noun> <maml:description> <maml:para>Export files to a zip file.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Export-PWDocumentFilesToZip</maml:name> <!-- Parameter: InputDocuments --> <command:parameter required="true" 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: OutputFileName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>File 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: FolderPrefixToRemove --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>FolderPrefixToRemove</maml:name> <maml:description> <maml:para>Will remove this from the front of the 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: UseDMSFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>UseDMSFolders</maml:name> <maml:description> <maml:para>Use DMS Folders and not full paths.</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: GetReferences --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>GetReferences</maml:name> <maml:description> <maml:para>Get references.</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: GetSetMembers --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>GetSetMembers</maml:name> <maml:description> <maml:para>If passed in document is a set, get the set members.</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: AddMetadataFile --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>AddMetadataFile</maml:name> <maml:description> <maml:para>Generate a metadata file to include in zip.</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: ExcludeSecondaryAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="6"> <maml:name>ExcludeSecondaryAuditTrail</maml:name> <maml:description> <maml:para>Sometimes helpful is secondary audit trail is huge.</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>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: OutputFileName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>File 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: FolderPrefixToRemove --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>FolderPrefixToRemove</maml:name> <maml:description> <maml:para>Will remove this from the front of the 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: UseDMSFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>UseDMSFolders</maml:name> <maml:description> <maml:para>Use DMS Folders and not full paths.</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: GetReferences --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>GetReferences</maml:name> <maml:description> <maml:para>Get references.</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: GetSetMembers --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>GetSetMembers</maml:name> <maml:description> <maml:para>If passed in document is a set, get the set members.</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: AddMetadataFile --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>AddMetadataFile</maml:name> <maml:description> <maml:para>Generate a metadata file to include in zip.</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: ExcludeSecondaryAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="6"> <maml:name>ExcludeSecondaryAuditTrail</maml:name> <maml:description> <maml:para>Sometimes helpful is secondary audit trail is huge.</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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>File on disk for output.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Will remove this from the front of the path.</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>Use DMS Folders and not full paths.</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>Get references.</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>If passed in document is a set, get the set members.</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>Generate a metadata file to include in zip.</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>Sometimes helpful is secondary audit trail is huge.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Gets an array of documents, exports them to a zip file, sets final status on each. Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" -DocumentName '%.pdf' -GetVersionsToo | Export-PWDocumentFilesToZip -OutputFile c:\export\ProjectPDFs.zip | Set-PWDocumentFinalStatus Get-PWDocumentFlatSet -FolderPath "Projects\Project 1\Deliverables Sets" -SetName "60 Percent Deliverables" | Export-PWDocumentFilesToZip -OutputFileName c:\temp\Deliverables.zip -GetReferences -GetSetMembers -AddMetadataFile </dev:code> </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> </command:details> <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: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> <!-- Parameter: Comment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Comment</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: 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> <!-- Parameter: Comment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Comment</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:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Set final status for all documents in a folder. #Get all the documents in this folder tree and set them to final status Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" | Set-PWDocumentFinalStatus #Get all the documents in this folder tree and clear final status Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" | Set-PWDocumentFinalStatus -RemoveFinalStatus</dev:code> </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: InputFolders --> <command:syntaxItem> <maml:name>Get-PWDocumentFlatSet</maml:name> <!-- Parameter: InputFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolders</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> <!-- Parameter set: Default --> <command:syntaxItem> <maml:name>Get-PWDocumentFlatSet</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <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="2"> <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: InputFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolders</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="true (ByValue)" position="1"> <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="2"> <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>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:inputType> <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> <dev:code>#Example usage Get-PWDocumentFlatSet to retrieve all flat set files. The following will return information for all flat set files within the current datasource. Get-PWDocumentFlatSet -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Example usage Get-PWDocumentFlat to retrieve flat sets files contained in a specified folder. The following will return information for all flat sets contained in a specified folder. Get-PWDocumentFlatSet -FolderPath 'Projects' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>#Example usage Get-PWDocumentFlat to retrieve a specific flat set file. The following will return information for a specific flat set file based on folder and set name. Get-PWDocumentFlatSet -FolderPath 'Projects' -SetName 'MyTest' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>#Example usage Get-PWDocumentFlat to retrieve flat sets from a folder array and then retrieve the members of the sets. Get-PWFolders -FolderPath 'Projects' | Get-PWDocumentFlatSet | Get-PWDocumentFlatSetMembers</dev:code> </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> <!-- Parameter: VersionLock --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VersionLock</maml:name> <maml:description> <maml:para>When the VersionLock switch parameter is included, the member document version will be persistent. Otherwise, will always use the latest version.</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> <!-- Parameter: VersionLock --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VersionLock</maml:name> <maml:description> <maml:para>When the VersionLock switch parameter is included, the member document version will be persistent. Otherwise, will always use the latest version.</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> <dev:code>#Example usage New-PWDocumentFlatSet. The following will create a new flat set file with the specified document as a member. $SetFileInfo = @{ FolderPath = 'Projects' SetName = 'MyTest' SetDescription = 'New Set File' SetMemberName = '2D-M-SAB-LNWK.dwg' SetMemberPath = 'Projects\Upload\Sub-Folder'} New-PWDocumentFlatSet @SetFileInfo -CheckOut -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>The following will create a new flat set file with the specified document as a member. The member will have Version Lock toggled on. $SetFileInfo = @{ FolderPath = 'Projects' SetName = 'MyTest' SetDescription = 'New Set File' SetMemberName = '2D-M-SAB-LNWK.dwg' SetMemberPath = 'Projects\Upload\Sub-Folder'} New-PWDocumentFlatSet @SetFileInfo -CheckOut -VersionLock -Verbose</dev:code> </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> <dev:code>#Example usage Remove-PWDocumentFlatSet. The following will delete the specified flat set file. Remove-PWDocumentFlatSet -FolderPath 'Projects' -SetName 'DGNs' -Verbose</dev:code> </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: InputDocuments --> <command:syntaxItem> <maml:name>Get-PWDocumentFlatSetByDocument</maml:name> <!-- Parameter: InputDocuments --> <command:parameter required="false" 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> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</dev:defaultValue> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <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="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DocumentName</maml:name> <maml:description> <maml:para>Name of document to find corresponding flat 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputDocuments --> <command:parameter required="false" 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> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</dev:defaultValue> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <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="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DocumentName</maml:name> <maml:description> <maml:para>Name of document to find corresponding flat 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:inputType> <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> <dev:code>#Example usage Get-PWDocumentFlatSetByDocument. The following will return information for all flat sets the specified document is a member of. Get-PWDocumentFlatSetByDocument -FolderPath 'Projects' -DocumentName 'MyDocument.dgn' -Verbose Get-PWDocumentsBySearch -FolderPath 'Projects' -FileName '%.dgn' | Get-PWDocumentFlatSetByDocument | Get-PWDocumentFlatSetMembers </dev:code> </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: InputDocuments --> <command:syntaxItem> <maml:name>Add-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: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Document object to add to the flat set. Only accepts one document object at a time.</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: 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> <!-- Parameter set: SetMemberNamePath --> <command:syntaxItem> <maml:name>Add-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: 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: 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: SetMemberPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <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: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 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: InputDocument --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>InputDocument</maml:name> <maml:description> <maml:para>Document object to add to the flat set. Only accepts one document object at a time.</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: 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="2"> <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>PWPS_DAB.CommonTypes+ProjectWiseDocument</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Document object to add to the flat set. Only accepts one document object at a time.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage Add-PWDocumentFlatSetMember. The following will add a new member to a flat set and set it to check out.. Add-PWDocumentFlatSetMember -FolderPath 'Projects' -SetName 'DGNs' -SetMemberName 'NewDrawing.dgn' -SetMemberPath 'Project\Drawings' -CheckOut -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Example usage Add-PWDocumentFlatSetMember. The following will add a new member to a flat set by passing a document object and toggle on Lock To Verion. $docs = Get-PWDocumentsBySearch -FolderPath 'Project\Drawings' -DocumentName 'NewDrawing.dgn' $docs | Add-PWDocumentFlatSetMember -FolderPath 'Projects' -SetName 'DGNs' -LockToVersion -Verbose</dev:code> </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> <dev:code>#Example usage Remove-PWDocumentFlatSetMember. The following will delete the member from the flat set. Remove-PWDocumentFlatSetMember -FolderPath 'Projects' -SetName 'DGNs' -SetMemberName 'MyDrawing.dgn' -Verbose</dev:code> </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: InputDocuments --> <command:syntaxItem> <maml:name>Get-PWDocumentFlatSetMembers</maml:name> <!-- Parameter: InputDocuments --> <command:parameter required="false" 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> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</dev:defaultValue> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <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="2"> <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: InputDocuments --> <command:parameter required="false" 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> <dev:defaultValue>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</dev:defaultValue> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <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="2"> <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>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:inputType> <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> <dev:code>#Example usage Get-PWDocumentFlatSetMembers. The following will display the members of a flat set. Get-PWDocumentFlatSetMembers -FolderPath 'Projects' -SetName 'DGNs' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Example usage Get-PWDocumentFlatMembers. Get-PWFolders -FolderPath 'Projects' | Get-PWDocumentFlatSet | Get-PWDocumentFlatSetMembers</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWDocumentFromParameters --> <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-PWDocumentFromParameters</command:name> <command:verb>Get</command:verb> <command:noun>PWDocumentFromParameters</command:noun> <maml:description> <maml:para>Get a single ProjectWise Document given folder, document name and version.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWDocumentFromParameters</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="false" 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> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>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: DocumentName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>DocumentName</maml:name> <maml:description> <maml:para>Document 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: FileName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Document 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: Version --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>Version</maml:name> <maml:description> <maml:para>Version.</maml: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>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> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>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: DocumentName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>DocumentName</maml:name> <maml:description> <maml:para>Document 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: FileName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Document 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: Version --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>Version</maml:name> <maml:description> <maml:para>Version.</maml: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>Folder object 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>Folder path.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Document Name (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>Document Name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Version.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ProjectWiseDocument --> <command:returnValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWDocumentFromParameters -FolderPath 'Top Level\Sub-Folder' -DocumentName Master.dgn -Version B</dev:code> </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> <dev:code>#Get GeoSpatial location of a document. #Get locations for all documents in a folder in WKT Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" | Get-PWDocumentGeoSpatialLocation #Get locations for all documents in a folder in KML Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" | Get-PWDocumentGeoSpatialLocation -GetKML #Get locations for all documents in a folder in GeoJSON Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" | Get-PWDocumentGeoSpatialLocation -GetGeoJSON</dev:code> </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> <dev:code>#Example usage for creating a new folder and assigning a location to it. New-PWFolder -FolderPath "My Locations\Folder 2" -StorageArea "Storage 1" | Set-PWFolderGeoSpatialLocation -Latitude 45 -Longitude 90 New-PWFolder -FolderPath "My Locations\Folder 3" -StorageArea "Storage 1" | Set-PWFolderGeoSpatialLocation -Address "704 15th Street, Durham, NC" -Point </dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWDocumentGroupAccess --> <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-PWDocumentGroupAccess</command:name> <command:verb>Remove</command:verb> <command:noun>PWDocumentGroupAccess</command:noun> <maml:description> <maml:para>Remove group access for one or more input documents.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Remove-PWDocumentGroupAccess</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: Group --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group to apply access 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> </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: Group --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group to apply access 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> </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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Group to apply access for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$targetDocs = Get-PWDocumentsBySearch -FolderPath "Target Documents\Folder 1" Remove-PWDocumentGroupAccess $targetDocs -Group 'Drafters'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWDocumentGroupAccess --> <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-PWDocumentGroupAccess</command:name> <command:verb>Set</command:verb> <command:noun>PWDocumentGroupAccess</command:noun> <maml:description> <maml:para>Set group access for one or more input documents.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Set-PWDocumentGroupAccess</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: Group --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group to apply access 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: Access --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Access</maml:name> <maml:description> <maml:para>Access 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: ApplyToVersions --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>ApplyToVersions</maml:name> <maml:description> <maml:para>Apply the security to versions of the input 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> </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: Group --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group to apply access 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: Access --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Access</maml:name> <maml:description> <maml:para>Access 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: ApplyToVersions --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>ApplyToVersions</maml:name> <maml:description> <maml:para>Apply the security to versions of the input 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> </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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Group to apply access for.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Access 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:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Apply the security to versions of the input documents.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$targetDocs = Get-PWDocumentsBySearch -FolderPath "Target Documents\Folder 1" Set-PWDocumentGroupAccess $targetDocs -Group 'Drafters' -Access 'r','w','fr','fw' Set-PWDocumentGroupAccess $targetDocs -Group 'Project Managers' -Access 'na'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Expand-PWDocumentInformation --> <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>Expand-PWDocumentInformation</command:name> <command:verb>Expand</command:verb> <command:noun>PWDocumentInformation</command:noun> <maml:description> <maml:para>Expands the information available on a document object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes an array of document objects from the pipeline and updates the blank properties.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>Expand-PWDocumentInformation</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> <dev:code> #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. $docs = Get-PWDocumentsBySearch -FolderPath "Lend Lease\Dotted PDFs" $docs2 = $docs | Where StorageName -eq "Storage7" $moreInfoDocs = Expand-PWDocumentInformation $docs2</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Purge-PWDocumentLocalCopy --> <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>Purge-PWDocumentLocalCopy</command:name> <command:verb>Purge</command:verb> <command:noun>PWDocumentLocalCopy</command:noun> <maml:description> <maml:para>Purge-PWDocumentLocalCopy removes the local working directory copy of the specified document(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Purge-PWDocumentLocalCopy removes the local working directory copy of the specified document(s). Documents can be passed via the pipeline.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>Purge-PWDocumentLocalCopy</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 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: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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> </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 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: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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> </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 to feed pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>The following will purge the local documents passed via the pipeline for the current user. Get-PWDocumentsBySearch -FolderPath "Projects\Test" | Purge-PWDocumentLocalCopy -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>The following will purge the local documents passed via the pipeline for the provided user. Get-PWDocumentsBySearch -FolderPath "Projects\Test" | Purge-PWDocumentLocalCopy -UserName 'powershellUser' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWDocumentLogicalSet --> <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-PWDocumentLogicalSet</command:name> <command:verb>Add</command:verb> <command:noun>PWDocumentLogicalSet</command:noun> <maml:description> <maml:para>Createa a logical set from a master document and an array of references.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Createa a logical set from a master document and an array of references. Masters cannot be DGNs or DWGs so as not to interfere with the integration-made references.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Master --> <command:syntaxItem> <maml:name>Add-PWDocumentLogicalSet</maml:name> <!-- Parameter: Master --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Master</maml:name> <maml:description> <maml:para>Master document.</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: References --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>References</maml:name> <maml:description> <maml:para>Reference document.</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: CheckOut --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>CheckOut</maml:name> <maml:description> <maml:para>If set, will build a check out relationship rather than 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Master --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Master</maml:name> <maml:description> <maml:para>Master document.</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: References --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>References</maml:name> <maml:description> <maml:para>Reference document.</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: CheckOut --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>CheckOut</maml:name> <maml:description> <maml:para>If set, will build a check out relationship rather than 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Master document.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Reference document.</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>If set, will build a check out relationship rather than a copy out.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$refs = Get-PWDocumentsBySearch -SearchName 'Some Search' $doc = Get-PWDocumentByURN "pw://decide-pwce-us.bentley.com:decide-pwce-us-10/Documents/D{f894a617-3b28-4858-b4e1-e4bd32b09613}" Add-PWDocumentLogicalSet $doc -References $refs</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWDocumentMIMEType --> <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-PWDocumentMIMEType</command:name> <command:verb>Set</command:verb> <command:noun>PWDocumentMIMEType</command:noun> <maml:description> <maml:para>Sets the MIMEType for a document.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets the MIMEType for a document.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Set-PWDocumentMIMEType</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 like that 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: MIMEType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>MIMEType</maml:name> <maml:description> <maml:para>Name of MIME Type to associate with 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: Fast --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Fast</maml:name> <maml:description> <maml:para>Bypass MIME Type validation.</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 like that 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: MIMEType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>MIMEType</maml:name> <maml:description> <maml:para>Name of MIME Type to associate with 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: Fast --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Fast</maml:name> <maml:description> <maml:para>Bypass MIME Type validation.</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 like that from Get-PWDocumentsBySearch.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Sets the MIMEType to MicroStation v8 for the specified documents. $docs = Show-PWDocumentSelectionDialog -FileExtension 'dgn' -Verbose Set-PWDocumentMIMEType -InputDocuments $docs -MIMEType 'image/vnd.dgn;ver=8'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWDocumentOwner --> <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-PWDocumentOwner</command:name> <command:verb>Update</command:verb> <command:noun>PWDocumentOwner</command:noun> <maml:description> <maml:para>Update-PWDocumentOwner sets the document owner to the specified user/group/userlist.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update-PWDocumentOwner sets the document owner to the specified user/group/userlist.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>Update-PWDocumentOwner</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: 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="2"> <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: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: 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="2"> <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>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> <dev:code>Updates the document owner to the ProjectWise Administrator user. Show-PWDocumentSelectionDialog | Update-PWDocumentOwner -OwnerType "User" -Owner "pwadmin" -Verbose </dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Invoke-PWDocumentProcessorRun --> <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>Invoke-PWDocumentProcessorRun</command:name> <command:verb>Invoke</command:verb> <command:noun>PWDocumentProcessorRun</command:noun> <maml:description> <maml:para>Invoke a non-scheduled run for one or more document processors.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Invoke-PWDocumentProcessorRun</maml:name> <!-- Parameter: FullText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>FullText</maml:name> <maml:description> <maml:para>Set to invoke Full Text Indexing</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: Thumbnail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Thumbnail</maml:name> <maml:description> <maml:para>Set to invoke Thumbnail processing</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: FileProperties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FileProperties</maml:name> <maml:description> <maml:para>Set to invoke File Properties processing</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: FullText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>FullText</maml:name> <maml:description> <maml:para>Set to invoke Full Text Indexing</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: Thumbnail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Thumbnail</maml:name> <maml:description> <maml:para>Set to invoke Thumbnail processing</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: FileProperties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FileProperties</maml:name> <maml:description> <maml:para>Set to invoke File Properties processing</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> <dev:code>Invoke-PWDocumentProcessorRun -FullText -Thumbnail -FileProperties </dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Clear-PWDocumentProcessorStatusByProject --> <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-PWDocumentProcessorStatusByProject</command:name> <command:verb>Clear</command:verb> <command:noun>PWDocumentProcessorStatusByProject</command:noun> <maml:description> <maml:para>Clear processing status for folders.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolders --> <command:syntaxItem> <maml:name>Clear-PWDocumentProcessorStatusByProject</maml:name> <!-- Parameter: InputFolders --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolders</maml:name> <maml:description> <maml:para>Folders to clear status for.</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: IncludeSubFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IncludeSubFolders</maml:name> <maml:description> <maml:para>Process Subfolders flag</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: FullText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FullText</maml:name> <maml:description> <maml:para>Set to clear Full Text Indexing 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> <!-- Parameter: Thumbnail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Thumbnail</maml:name> <maml:description> <maml:para>Set to clear Thumbnail processing 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> <!-- Parameter: FileProperties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>FileProperties</maml:name> <maml:description> <maml:para>Set to clear File Properties processing 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: InputFolders --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolders</maml:name> <maml:description> <maml:para>Folders to clear status for.</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: IncludeSubFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IncludeSubFolders</maml:name> <maml:description> <maml:para>Process Subfolders flag</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: FullText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FullText</maml:name> <maml:description> <maml:para>Set to clear Full Text Indexing 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> <!-- Parameter: Thumbnail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Thumbnail</maml:name> <maml:description> <maml:para>Set to clear Thumbnail processing 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> <!-- Parameter: FileProperties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>FileProperties</maml:name> <maml:description> <maml:para>Set to clear File Properties processing 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+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Folders to clear status for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWFolders -FolderPath 'AMEC-FosterWheeler' | Clear-PWDocumentProcessorStatusByProject -FullText -Thumbnail -FileProperties </dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWDocumentProcessorToDatasource --> <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-PWDocumentProcessorToDatasource</command:name> <command:verb>Add</command:verb> <command:noun>PWDocumentProcessorToDatasource</command:noun> <maml:description> <maml:para>Add index server to configuration.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-PWDocumentProcessorToDatasource</maml:name> <!-- Parameter: IndexServerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>IndexServerName</maml:name> <maml:description> <maml:para>Name for text indexing 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: IndexServerHostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IndexServerHostName</maml:name> <maml:description> <maml:para>FQDN for 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: FullText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FullText</maml:name> <maml:description> <maml:para>Configure Full Text Indexing</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: Thumbnail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Thumbnail</maml:name> <maml:description> <maml:para>Configure Thumbnail processing</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: FileProperties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>FileProperties</maml:name> <maml:description> <maml:para>Configure File Property processing</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: ExtractionUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>ExtractionUser</maml:name> <maml:description> <maml:para>User name for extractions</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExtractionUserPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ExtractionUserPassword</maml:name> <maml:description> <maml:para>Password for extraction user</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: AddFullTextServer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>AddFullTextServer</maml:name> <maml:description> <maml:para>Add the server specified 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: IndexServerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>IndexServerName</maml:name> <maml:description> <maml:para>Name for text indexing 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: IndexServerHostName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>IndexServerHostName</maml:name> <maml:description> <maml:para>FQDN for 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: FullText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FullText</maml:name> <maml:description> <maml:para>Configure Full Text Indexing</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: Thumbnail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Thumbnail</maml:name> <maml:description> <maml:para>Configure Thumbnail processing</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: FileProperties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>FileProperties</maml:name> <maml:description> <maml:para>Configure File Property processing</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: ExtractionUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>ExtractionUser</maml:name> <maml:description> <maml:para>User name for extractions</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExtractionUserPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ExtractionUserPassword</maml:name> <maml:description> <maml:para>Password for extraction user</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: AddFullTextServer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>AddFullTextServer</maml:name> <maml:description> <maml:para>Add the server specified 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> <dev:code>Add-PWDocumentProcessorToDatasource -AddFullTextServer -IndexServerName "naou22468a" -IndexServerHostName "naou22468a.bentley.com" -FullText -Thumbnail -FileProperties -ExtractionUser pwadmin -ExtractionUserPassword [SecureString] </dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Backup-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>Backup-PWDocumentProperties</command:name> <command:verb>Backup</command:verb> <command:noun>PWDocumentProperties</command:noun> <maml:description> <maml:para>Backup the properties table and empty it before running dmsconv.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Backup-PWDocumentProperties</maml:name> <!-- Parameter: ODBCDatasourceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ODBCDatasourceName</maml:name> <maml:description> <maml:para>ODBC Datasource name (same as would be used for DMSCONV).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ODBCUserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ODBCUserName</maml:name> <maml:description> <maml:para>ODBC User name (same as would be used for DMSCONV).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ODBCPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ODBCPassword</maml:name> <maml:description> <maml:para>ODBC Password (same as would be used for DMSCONV).</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: IsOracle --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>IsOracle</maml:name> <maml:description> <maml:para>Set if Oracle datasource. SQL Server will be assumed.</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: ODBCDatasourceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ODBCDatasourceName</maml:name> <maml:description> <maml:para>ODBC Datasource name (same as would be used for DMSCONV).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ODBCUserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ODBCUserName</maml:name> <maml:description> <maml:para>ODBC User name (same as would be used for DMSCONV).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ODBCPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ODBCPassword</maml:name> <maml:description> <maml:para>ODBC Password (same as would be used for DMSCONV).</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: IsOracle --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>IsOracle</maml:name> <maml:description> <maml:para>Set if Oracle datasource. SQL Server will be assumed.</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> <dev:code>Backup-PWDocumentProperties -IsOracle -ODBCDatasourceName PWDS2 -ODBCUserName user -ODBCPassword (Read-Host -Prompt "ODBC Password:" -AsSecureString)</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Restore-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>Restore-PWDocumentProperties</command:name> <command:verb>Restore</command:verb> <command:noun>PWDocumentProperties</command:noun> <maml:description> <maml:para>Restore the properties from the backup table after running dmsconv. Optionally do the UTC Conversion (takes a long time).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>When doing the UTC Conversion in Oracle, you may have to execute ALTER SYSTEM SET open_cursors = 400 SCOPE=BOTH; to get it to complete cleanly.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Restore-PWDocumentProperties</maml:name> <!-- Parameter: PerformUTCConversion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>PerformUTCConversion</maml:name> <maml:description> <maml:para>Will update the dates in the properties table to UTC if specified. Otherwise, cmdlet will just restore the backed up values.</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: ODBCDatasourceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ODBCDatasourceName</maml:name> <maml:description> <maml:para>ODBC Datasource name (same as would be used for DMSCONV).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ODBCUserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ODBCUserName</maml:name> <maml:description> <maml:para>ODBC User name (same as would be used for DMSCONV).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ODBCPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>ODBCPassword</maml:name> <maml:description> <maml:para>ODBC Password (same as would be used for DMSCONV).</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: IsOracle --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>IsOracle</maml:name> <maml:description> <maml:para>Set if Oracle datasource. SQL Server will be assumed.</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: PerformUTCConversion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>PerformUTCConversion</maml:name> <maml:description> <maml:para>Will update the dates in the properties table to UTC if specified. Otherwise, cmdlet will just restore the backed up values.</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: ODBCDatasourceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ODBCDatasourceName</maml:name> <maml:description> <maml:para>ODBC Datasource name (same as would be used for DMSCONV).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ODBCUserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ODBCUserName</maml:name> <maml:description> <maml:para>ODBC User name (same as would be used for DMSCONV).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ODBCPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>ODBCPassword</maml:name> <maml:description> <maml:para>ODBC Password (same as would be used for DMSCONV).</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: IsOracle --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>IsOracle</maml:name> <maml:description> <maml:para>Set if Oracle datasource. SQL Server will be assumed.</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> <dev:code>Restore-PWDocumentProperties -IsOracle -PerformUTCConversion -ODBCDatasourceName PWDS2 -ODBCUserName user -ODBCPassword (Read-Host -Prompt "ODBC Password:" -AsSecureString)</dev:code> </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> <dev:code> #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. $docs = Get-PWDocumentsBySearch -FolderPath "Lend Lease\Dotted PDFs" foreach ($doc in $docs) { $doc.Description = "Changed in PowerShell 2" $doc.Version = "R06" } Update-PWDocumentProperties -InputDocument $docs Get-PWDocumentsBySearch -FolderPath "Lend Lease\Dotted PDFs" | Foreach -MemberName Description</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWDocumentPropertyCount --> <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-PWDocumentPropertyCount</command:name> <command:verb>Get</command:verb> <command:noun>PWDocumentPropertyCount</command:noun> <maml:description> <maml:para>Get count of document property records or documents with document property records. Useful to know when backing up before dmsconv.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWDocumentPropertyCount</maml:name> <!-- Parameter: CountDocuments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>CountDocuments</maml:name> <maml:description> <maml:para>Count the indexed 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: CountDocuments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>CountDocuments</maml:name> <maml:description> <maml:para>Count the indexed 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> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$recs=Get-PWDocumentPropertyCount</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWDocumentReference --> <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-PWDocumentReference</command:name> <command:verb>Add</command:verb> <command:noun>PWDocumentReference</command:noun> <maml:description> <maml:para>Add a reference file to a master file.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Master --> <command:syntaxItem> <maml:name>Add-PWDocumentReference</maml:name> <!-- Parameter: Master --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Master</maml:name> <maml:description> <maml:para>Master document.</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: Reference --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Reference</maml:name> <maml:description> <maml:para>Reference document.</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: ElementId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>ElementId</maml:name> <maml:description> <maml:para>Elemnt ID.</maml:para> </maml:description> <command:parameterValue required="true">ulong</command:parameterValue> <dev:type> <maml:name>System.UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MasterModelId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>MasterModelId</maml:name> <maml:description> <maml:para>Optional master model id (defaults to 0).</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: ReferenceModelId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>ReferenceModelId</maml:name> <maml:description> <maml:para>Optional reference model id (defaults to 0).</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: NestDepth --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>NestDepth</maml:name> <maml:description> <maml:para>Optional nest depth (defaults to 0).</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: Type --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="6"> <maml:name>Type</maml:name> <maml:description> <maml:para>Optional reference type (defaults to 177).</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: Flags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="7"> <maml:name>Flags</maml:name> <maml:description> <maml:para>Optional flags (defaults to 2).</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: IsRaster --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="8"> <maml:name>IsRaster</maml:name> <maml:description> <maml:para>Set for raster attachment.</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: CheckOut --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="9"> <maml:name>CheckOut</maml:name> <maml:description> <maml:para>If set, will build a check out relationship rather than 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: NonCADFile --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="9"> <maml:name>NonCADFile</maml:name> <maml:description> <maml:para>If set, will only create set relationship and not reference file relationships.</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: Master --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Master</maml:name> <maml:description> <maml:para>Master document.</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: Reference --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Reference</maml:name> <maml:description> <maml:para>Reference document.</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: ElementId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>ElementId</maml:name> <maml:description> <maml:para>Elemnt ID.</maml:para> </maml:description> <command:parameterValue required="true">ulong</command:parameterValue> <dev:type> <maml:name>System.UInt64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MasterModelId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>MasterModelId</maml:name> <maml:description> <maml:para>Optional master model id (defaults to 0).</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: ReferenceModelId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>ReferenceModelId</maml:name> <maml:description> <maml:para>Optional reference model id (defaults to 0).</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: NestDepth --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>NestDepth</maml:name> <maml:description> <maml:para>Optional nest depth (defaults to 0).</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: Type --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="6"> <maml:name>Type</maml:name> <maml:description> <maml:para>Optional reference type (defaults to 177).</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: Flags --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="7"> <maml:name>Flags</maml:name> <maml:description> <maml:para>Optional flags (defaults to 2).</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: IsRaster --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="8"> <maml:name>IsRaster</maml:name> <maml:description> <maml:para>Set for raster attachment.</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: NonCADFile --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="9"> <maml:name>NonCADFile</maml:name> <maml:description> <maml:para>If set, will only create set relationship and not reference file relationships.</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: CheckOut --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="9"> <maml:name>CheckOut</maml:name> <maml:description> <maml:para>If set, will build a check out relationship rather than 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Master document.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Reference document.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.UInt64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Elemnt ID.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Optional master model id (defaults to 0).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Optional reference model id (defaults to 0).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Optional nest depth (defaults to 0).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Optional reference type (defaults to 177).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Optional flags (defaults to 2).</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>Set for raster attachment.</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>If set, will only create set relationship and not reference file relationships.</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>If set, will build a check out relationship rather than a copy out.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Add-PWDocumentReference $doc -Reference $ref -ElementId 808</dev:code> </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>01/01/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: ExcludeSecondaryAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>ExcludeSecondaryAuditTrail</maml:name> <maml:description> <maml:para>Don't include secondary audit trail records. Sometimes required for 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: DocumentName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>DocumentName</maml:name> <maml:description> <maml:para>Document name. Supports % wild card.</maml:para> </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="15"> <maml:name>FileName</maml:name> <maml:description> <maml:para>File name. Supports % wild card.</maml:para> </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>01/01/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>01/01/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>01/01/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>01/01/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>01/01/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: ExcludeSecondaryAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>ExcludeSecondaryAuditTrail</maml:name> <maml:description> <maml:para>Don't include secondary audit trail records. Sometimes required for 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: DocumentName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>DocumentName</maml:name> <maml:description> <maml:para>Document name. Supports % wild card.</maml:para> </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="15"> <maml:name>FileName</maml:name> <maml:description> <maml:para>File name. Supports % wild card.</maml: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> <dev:code>#Example usage for reporting on documents. #Will report on the documents ONLY in the folder identified by the folder path. Save-PWDocumentReport -ProjectWiseFolder "PWPS Connected Project Test 6\Projects 2\Project A" -OutputFileName "c:\\temp\\xmittalReport.xlsx" #Will report on the documents ONLY in the folder identified by the folder path. Will include audit trail and versions. Save-PWDocumentReport -ProjectWiseFolder "PWPS Connected Project Test 6\Projects 2\Project A" -IncludeVersions -IncludeAuditTrail -OutputFileName "c:\\temp\\xmittalReport.xlsx" #Will report on the documents in the folder and all sub-folders identified by the folder path. Will include audit trail and versions. Save-PWDocumentReport -ProjectWiseFolder "PWPS Connected Project Test 6\Projects 2\Project A" -IncludeVersions -Recurse -IncludeAuditTrail -OutputFileName "c:\\temp\\xmittalReport.xlsx" #Will report on the documents in the saved search including the audit trail (will only include versions if they are included in search) Save-PWDocumentReport -SearchName "60% Complete" -IncludeAuditTrail -OutputFileName "c:\\temp\\xmittalReport.xlsx" #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. 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</dev:code> </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: DocumentName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>DocumentName</maml:name> <maml:description> <maml:para>Document name. Supports % wild card.</maml:para> </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="11"> <maml:name>FileName</maml:name> <maml:description> <maml:para>File name. Supports % wild card.</maml:para> </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>01/01/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>01/01/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> <!-- Parameter: ExcludeSecondaryAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>ExcludeSecondaryAuditTrail</maml:name> <maml:description> <maml:para>Don't include secondary audit trail records. Sometimes required for 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> </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>01/01/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>01/01/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> <!-- Parameter: ExcludeSecondaryAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>ExcludeSecondaryAuditTrail</maml:name> <maml:description> <maml:para>Don't include secondary audit trail records. Sometimes required for 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: DocumentName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>DocumentName</maml:name> <maml:description> <maml:para>Document name. Supports % wild card.</maml:para> </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="11"> <maml:name>FileName</maml:name> <maml:description> <maml:para>File name. Supports % wild card.</maml: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> <dev:code>#Will report on the documents ONLY in the folder identified by the folder path Get-PWDocumentReportDataTable -ProjectWiseFolder "PWPS Connected Project Test 6\Projects 2\Project A" #Will report on the documents ONLY in the folder identified by the folder path, and will include audit trail and versions. Get-PWDocumentReportDataTable -ProjectWiseFolder "PWPS Connected Project Test 6\Projects 2\Project A" -IncludeAuditTrail -IncludeVersions #Will report on the documents in the folder identified by the folder path and all sub-folders. Get-PWDocumentReportDataTable -ProjectWiseFolder "PWPS Connected Project Test 6\Projects 2\Project A" -Recurse #Will report on the documents in the folder identified by the folder path and all sub-folders. Will include audit trail and versions. Get-PWDocumentReportDataTable -ProjectWiseFolder "PWPS Connected Project Test 6\Projects 2\Project A" -Recurse -IncludeAuditTrail -IncludeVersions #Will report on the documents ONLY in the folder identified by the folder path Get-PWDocumentReportDataTable -ProjectWiseFolder "PWPS Connected Project Test 6\Projects 2\Project A" #Will report on the documents in the saved search. Get-PWDocumentReportDataTable -SearchName "60% Complete" #Will report on the documents in the saved search including the audit trail (will only include versions if they are included in search) Get-PWDocumentReportDataTable -SearchName "60% Complete" -IncludeAuditTrail #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. Get-PWDocumentReportDataTable -ProjectWiseFolder "PWPS Connected Project Test 6\Projects 2\Project A" -IncludeVersions -Recurse -IncludeAuditTrail -AuditTrailRecordsStart 2015-01-01 -AuditTrailRecordEnd 2015-12-31</dev:code> </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: 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> <!-- Parameter set: Export --> <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: 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> <!-- Parameter set: CopyOut --> <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: 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> <dev:code>New-PWLogin -DatasourceName Server:DSN #Get the documents in just this folder (and their versions) where the file name pattern matches %.pdf Get-PWDocumentsBySearch -FolderPath 'Microstation J' -FileName '%.dgn' | CheckOut-PWDocuments | Select-Object CheckedOutLocalFileName #Should check out all the PDFs in that folder and populate the CheckedOutLocalFileName property on the document object</dev:code> </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>Despite the name, copies out files to a folder and optionally writes metadata to a spreadsheet.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Export metadata files is in same format as Save-PWDocumentReport. NOTE: Version support assumes Document Name consistency in the version stack. The export will probably work, but the import from the spreadsheet assumes that document names are constant through the stack.</maml:para> <maml:para>Folder structure is preserved (even long paths so make sure you have a Windows File Explorer replacement that can navigate long paths).</maml:para> <maml:para>This will not overwrite a file on the disk unless the file in ProjectWise is newer. Intent is to maintain an up-to-date mirror of the files from ProjectWise on-disk. So, this cmdlet would be good for use in a scheduled task. Some users use this as a fetch-files replacement.</maml:para> <maml:para>The last file update date from ProjectWise and the ProjectWise document create date are preserved in the copied out file.</maml:para> </maml:description> <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: UseDMSFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>UseDMSFolders</maml:name> <maml:description> <maml:para>Use DMS Folders and not full paths.</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> <!-- Parameter: UseDMSFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>UseDMSFolders</maml:name> <maml:description> <maml:para>Use DMS Folders and not full paths.</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> <dev:code>#Will export documents returned by the listed saved searches. Export-PWDocuments -OutputFolder c:\export -Searches "60% Complete;80% Complete;90% Complete" -ExportMetadata -ExportMetadataFile "c:\temp\output.xlsx" #Will export documents in given folder and write metadata file with default filename and set exported (copied out) files to final status. Export-PWDocuments -OutputFolder c:\export -ProjectWiseFolder "Source A\Subfolder 1" -ExportMetadata -ExportMetadataFile "c:\temp\output2.xlsx" | Set-PWDocumentFinalStatus #Gets a document, exports it with metadat and sets final status. Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" -DocumentName 'Final Site Plan' | Export-PWDocuments -OutputFolder c:\export -ExportMetadata | Set-PWDocumentFinalStatus </dev:code> </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. Can be a UNC Path or can be a long path specification (\\?\c:\, \\?\UNC\Server\Share\)</maml:para> </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: ExcludeSourceDirectoryFromTargetPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>ExcludeSourceDirectoryFromTargetPath</maml:name> <maml:description> <maml:para>Set this to exclude the source directory from the target path. So, if set, then D:\Export\Folder1\file1.dgn becomes 'ProjectWise Parent\Folder1\file1.dgn'</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: IncludeEmptyFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>IncludeEmptyFolders</maml:name> <maml:description> <maml:para>Foolishly include empty 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: FoldersOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="12"> <maml:name>FoldersOnly</maml:name> <maml:description> <maml:para>Replicate folders 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: ServerIsUtc --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>ServerIsUtc</maml:name> <maml:description> <maml:para>For date matching</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: SkipDateCheck --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>SkipDateCheck</maml:name> <maml:description> <maml:para>Skip the date check for existing files.</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: SuppressOutput --> <command:parameter required="false" globbing="false" pipelineInput="false" position="15"> <maml:name>SuppressOutput</maml:name> <maml:description> <maml:para>There's some thought that this might improve 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: ValidationReport --> <command:parameter required="false" globbing="false" pipelineInput="false" position="16"> <maml:name>ValidationReport</maml:name> <maml:description> <maml:para>Full path to XLSX file for output (c:\temp\ImportValidation.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: Exclusions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="17"> <maml:name>Exclusions</maml:name> <maml:description> <maml:para>Filenames and patterns to exclude (e.g. "thumbs.db","*.lnk","*.tmp").</maml:para> </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 to INCLUDE (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: DefaultState --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>DefaultState</maml:name> <maml:description> <maml:para>Set default workflow state for new documents being 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="7"> <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="8"> <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> <!-- Parameter: Overwrite --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>Overwrite</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. Can be a UNC Path or can be a long path specification (\\?\c:\, \\?\UNC\Server\Share\)</maml:para> </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 to INCLUDE (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: Exclusions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="17"> <maml:name>Exclusions</maml:name> <maml:description> <maml:para>Filenames and patterns to exclude (e.g. "thumbs.db","*.lnk","*.tmp").</maml:para> </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: DefaultState --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>DefaultState</maml:name> <maml:description> <maml:para>Set default workflow state for new documents being 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="7"> <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="8"> <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> <!-- Parameter: Overwrite --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>Overwrite</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> <!-- Parameter: ExcludeSourceDirectoryFromTargetPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>ExcludeSourceDirectoryFromTargetPath</maml:name> <maml:description> <maml:para>Set this to exclude the source directory from the target path. So, if set, then D:\Export\Folder1\file1.dgn becomes 'ProjectWise Parent\Folder1\file1.dgn'</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: IncludeEmptyFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>IncludeEmptyFolders</maml:name> <maml:description> <maml:para>Foolishly include empty 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: FoldersOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="12"> <maml:name>FoldersOnly</maml:name> <maml:description> <maml:para>Replicate folders 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: ServerIsUtc --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>ServerIsUtc</maml:name> <maml:description> <maml:para>For date matching</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: SkipDateCheck --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>SkipDateCheck</maml:name> <maml:description> <maml:para>Skip the date check for existing files.</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: SuppressOutput --> <command:parameter required="false" globbing="false" pipelineInput="false" position="15"> <maml:name>SuppressOutput</maml:name> <maml:description> <maml:para>There's some thought that this might improve 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: ValidationReport --> <command:parameter required="false" globbing="false" pipelineInput="false" position="16"> <maml:name>ValidationReport</maml:name> <maml:description> <maml:para>Full path to XLSX file for output (c:\temp\ImportValidation.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> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for reporting on documents. #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. #Creates versions of duplicate files with the given switch. Import-PWDocuments -InputFolder "c:\files\subfolder" -ProjectWiseFolder "Target A\Folder 1" -ExtensionsOfInterest ".dgn;.dwg" -DefaultStorage Store01 -CreateVersions #Will import files from Input folder. Shows use of pipeline. Import-PWDocuments -InputFolder "c:\files" -ProjectWiseFolder "Target A" -DefaultStorage Store01 -DefaultWorkflow Normal | Set-PWDocumentState -State "Archived" #Import documents with exclusions. $docs = Import-PWDocuments -InputFolder 'W:\Import Test' -ProjectWiseFolder 'Import test for rob\Test 03' -DefaultStorage Storage -Overwrite -Exclusions 'Amason S3 Keys.txt','msconfigreport.txt'</dev:code> </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> <dev:code>#Get the documents in the given path and delete them Get-PWDocumentsBySearch -FolderPath 'Import\Test' -FileName '02_%.pdf'| Remove-PWDocuments</dev:code> </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-PWDocumentsBetweenDatasources --> <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-PWDocumentsBetweenDatasources</command:name> <command:verb>Copy</command:verb> <command:noun>PWDocumentsBetweenDatasources</command:noun> <maml:description> <maml:para>Copies documents to a target folder in another datasource.</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 in another datasource.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>Copy-PWDocumentsBetweenDatasources</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: TargetDatasource --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetDatasource</maml:name> <maml:description> <maml:para>Target datasource 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: TargetFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <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> </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: TargetDatasource --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetDatasource</maml:name> <maml:description> <maml:para>Target datasource 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: TargetFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <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> </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> <dev:code>#Get documents and copy them to a target folder in another datasource New-PWLogin brumd09515rem:pwv8i $docs = Show-PWDocumentSelectionDialog $encryptedPassword = Read-Host -Prompt "Enter Password:" -AsSecureString New-PWLogin brumd09515rem:ImportTest2 -UserName pwadmin -Password $encryptedPassword $folder = Show-PWFolderBrowserDialog Set-PWSession brumd09515rem:pwv8i Copy-PWDocumentsBetweenDatasources $docs -TargetDatasource brumd09515rem:importtest2 -TargetFolderPath $folder.FullPath</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWDocumentsByGUIDs --> <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-PWDocumentsByGUIDs</command:name> <command:verb>Get</command:verb> <command:noun>PWDocumentsByGUIDs</command:noun> <maml:description> <maml:para>Returns an array of document object(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns an array document object(s) with the provided GUIDs.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Array of Document GUIDs. --> <command:syntaxItem> <maml:name>Get-PWDocumentsByGUIDs</maml:name> <!-- Parameter: DocumentGUIDs --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DocumentGUIDs</maml:name> <maml:description> <maml:para>Array of Document GUIDs.</maml: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: DocumentGUIDs --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DocumentGUIDs</maml:name> <maml:description> <maml:para>Array of Document GUIDs.</maml: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> <dev:code>Returns the document object with the specified GUID. Get-PWDocumentsByGUIDs -DocumentGUIDs 'd0bc426a-973e-4ebe-8764-7739e81e9182' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Returns the document object(s) with the specified GUIDs. Get-PWDocumentsByGUIDs -DocumentGUIDs 'd0bc426a-973e-4ebe-8764-7739e81e9182', '31050aa0-bf0c-4804-a9f4-236c54496f33' -Verbose</dev:code> </command:example> </command:examples> </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> <dev:code>Copy contents of source folder to target folder Copy-PWDocumentsByProject -SourceFolderPath 'Top Level\Sub-Folder' -TargetFolderPath 'Top Level 2\Sub-Folder 2' -DefaultStorageArea Storage01</dev:code> </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> <!-- Parameter: CopyReferenceRelationships --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>CopyReferenceRelationships</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> <!-- Parameter: CopyReferenceRelationships --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>CopyReferenceRelationships</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> <dev:code>#Example copying documents. The following will copy all documents returned from the saved search to a target folder. Copy-PWDocumentsBySearch -SearchName 'DGNS' -FolderPath 'Projects\CopyToHere' -DefaultStorageArea 'Storage'</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Example copying documents with replicatepaths parameter included. The following will copy all documents returned from the saved search to a target folder and replicate source folder structure. Copy-PWDocumentsBySearch -SearchName 'DGNS' -FolderPath 'Projects\CopyToHere' -DefaultStorageArea 'Storage' -ReplicatePaths</dev:code> </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: Attributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <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="11"> <maml:name>Slow</maml:name> <maml:description> <maml:para>Set to fill in document name path and attributes in document object (same as -GetAttributes). It is much faster to use Get-PWDocumentsBySearchWithReturnColumns.</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>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: ReturnDataTable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>ReturnDataTable</maml:name> <maml:description> <maml:para>Return DataTable object rather than array of Document objects.</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: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>Version</maml:name> <maml:description> <maml:para>Version to filter 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: PopulatePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="15"> <maml:name>PopulatePath</maml:name> <maml:description> <maml:para>Populate path on return objects/table. Will degrade performance, but not as much as -GetAttributes or -Slow.</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: LatitudeMin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="16"> <maml:name>LatitudeMin</maml:name> <maml:description> <maml:para>Minimum latitude in decimal degrees. Range -90.00 to 90.00.</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>1.79769313486232E+308</dev:defaultValue> </command:parameter> <!-- Parameter: LongitudeMin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="17"> <maml:name>LongitudeMin</maml:name> <maml:description> <maml:para>Minimum longitude in decimal degrees. Range -180.00 to 180.00.</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>1.79769313486232E+308</dev:defaultValue> </command:parameter> <!-- Parameter: LatitudeMax --> <command:parameter required="false" globbing="false" pipelineInput="false" position="18"> <maml:name>LatitudeMax</maml:name> <maml:description> <maml:para>Maximum latitude in decimal degrees. Range -90.00 to 90.00.</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>1.79769313486232E+308</dev:defaultValue> </command:parameter> <!-- Parameter: LongitudeMax --> <command:parameter required="false" globbing="false" pipelineInput="false" position="19"> <maml:name>LongitudeMax</maml:name> <maml:description> <maml:para>Maximum longitude in decimal degrees. Range -180.00 to 180.00.</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>1.79769313486232E+308</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 path to search.</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: FullTextSearchMatchAllWords --> <command:parameter required="false" globbing="false" pipelineInput="false" position="20"> <maml:name>FullTextSearchMatchAllWords</maml:name> <maml:description> <maml:para>If SearchString is provided, this will split the string into words at the spaces and require the content to contain all of the words in the string. Otherwise, will match on 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: FullTextSearchMatchWholePhrase --> <command:parameter required="false" globbing="false" pipelineInput="false" position="21"> <maml:name>FullTextSearchMatchWholePhrase</maml:name> <maml:description> <maml:para>If SearchString is provided, this searches for the whole phrase and does not split the string into words.</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: FullTextSearchAttributeValues --> <command:parameter required="false" globbing="false" pipelineInput="false" position="22"> <maml:name>FullTextSearchAttributeValues</maml:name> <maml:description> <maml:para>If SearchString is provided, this searches in the attribute values rather than in the file content.</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="3"> <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="4"> <maml:name>GetAttributes</maml:name> <maml:description> <maml:para>Populate attributes in document object. Will degrade performance. It is much faster to use Get-PWDocumentsBySearchWithReturnColumns.</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="5"> <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="6"> <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="7"> <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="8"> <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="9"> <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> </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: FolderID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FolderID</maml:name> <maml:description> <maml:para>Folder path to search.</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: GetVersionsToo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <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="4"> <maml:name>GetAttributes</maml:name> <maml:description> <maml:para>Populate attributes in document object. Will degrade performance. It is much faster to use Get-PWDocumentsBySearchWithReturnColumns.</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="5"> <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="6"> <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="7"> <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="8"> <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="9"> <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="10"> <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="11"> <maml:name>Slow</maml:name> <maml:description> <maml:para>Set to fill in document name path and attributes in document object (same as -GetAttributes). It is much faster to use Get-PWDocumentsBySearchWithReturnColumns.</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>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: ReturnDataTable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>ReturnDataTable</maml:name> <maml:description> <maml:para>Return DataTable object rather than array of Document objects.</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: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>Version</maml:name> <maml:description> <maml:para>Version to filter 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: PopulatePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="15"> <maml:name>PopulatePath</maml:name> <maml:description> <maml:para>Populate path on return objects/table. Will degrade performance, but not as much as -GetAttributes or -Slow.</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: LatitudeMin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="16"> <maml:name>LatitudeMin</maml:name> <maml:description> <maml:para>Minimum latitude in decimal degrees. Range -90.00 to 90.00.</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>1.79769313486232E+308</dev:defaultValue> </command:parameter> <!-- Parameter: LongitudeMin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="17"> <maml:name>LongitudeMin</maml:name> <maml:description> <maml:para>Minimum longitude in decimal degrees. Range -180.00 to 180.00.</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>1.79769313486232E+308</dev:defaultValue> </command:parameter> <!-- Parameter: LatitudeMax --> <command:parameter required="false" globbing="false" pipelineInput="false" position="18"> <maml:name>LatitudeMax</maml:name> <maml:description> <maml:para>Maximum latitude in decimal degrees. Range -90.00 to 90.00.</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>1.79769313486232E+308</dev:defaultValue> </command:parameter> <!-- Parameter: LongitudeMax --> <command:parameter required="false" globbing="false" pipelineInput="false" position="19"> <maml:name>LongitudeMax</maml:name> <maml:description> <maml:para>Maximum longitude in decimal degrees. Range -180.00 to 180.00.</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>1.79769313486232E+308</dev:defaultValue> </command:parameter> <!-- Parameter: FullTextSearchMatchAllWords --> <command:parameter required="false" globbing="false" pipelineInput="false" position="20"> <maml:name>FullTextSearchMatchAllWords</maml:name> <maml:description> <maml:para>If SearchString is provided, this will split the string into words at the spaces and require the content to contain all of the words in the string. Otherwise, will match on 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: FullTextSearchMatchWholePhrase --> <command:parameter required="false" globbing="false" pipelineInput="false" position="21"> <maml:name>FullTextSearchMatchWholePhrase</maml:name> <maml:description> <maml:para>If SearchString is provided, this searches for the whole phrase and does not split the string into words.</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: FullTextSearchAttributeValues --> <command:parameter required="false" globbing="false" pipelineInput="false" position="22"> <maml:name>FullTextSearchAttributeValues</maml:name> <maml:description> <maml:para>If SearchString is provided, this searches in the attribute values rather than in the file content.</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> <dev:code>#Example usages for searching for documents. Import-Module pwps_dab New-PWLogin Server:DSN #Get the documents in just this folder (and their versions) where the file name pattern matches %.pdf Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" -GetVersionsToo -JustThisFolder -Filename '%.pdf' #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 Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" -GetVersionsToo -SearchString 'Primary' -Filename '%.pdf' #Get the active documents in this folder tree matching these attributes Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" -Attributes @{Name = 'Value'; Name2 = 'Value2' } #Get the documents returned by the saved search Get-PWDocumentsBySearch -SearchName "PDFs in Project" #Get the documents returned by the saved search (note path definition) and populate the attributes and extended information (can be quite slow) Get-PWDocumentsBySearch -SearchName "Rich Project From PowerShell\Project 02\PDF Search made by PowerShell" -GetAttributes</dev:code> </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> <dev:code>#Example removing documents. The following will remove all documents returned from the saved search. Remove-PWDocumentsBySearch -SearchName 'DGNS'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWDocumentsBySearchWithReturnColumns --> <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-PWDocumentsBySearchWithReturnColumns</command:name> <command:verb>Get</command:verb> <command:noun>PWDocumentsBySearchWithReturnColumns</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-PWDocumentsBySearchWithReturnColumns</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.</maml:para> </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="1"> <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: FileUpdatedBefore --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>FileUpdatedBefore</maml:name> <maml:description> <maml:para>File 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>01/01/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: ColumnsToReturn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>ColumnsToReturn</maml:name> <maml:description> <maml:para>List of columns to populate in search results (not validated).</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReturnDataTable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="12"> <maml:name>ReturnDataTable</maml:name> <maml:description> <maml:para>If set, will return a data table. Default is to return an arrary of document objects.</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: PopulatePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>PopulatePath</maml:name> <maml:description> <maml:para>Populate path on return objects/table. Will degrade performance somewhat.</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: FullTextSearchMatchAllWords --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>FullTextSearchMatchAllWords</maml:name> <maml:description> <maml:para>If SearchString is provided, this will split the string into words at the spaces and require the content to contain all of the words in the string. Otherwise, will match on 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: FullTextSearchMatchWholePhrase --> <command:parameter required="false" globbing="false" pipelineInput="false" position="15"> <maml:name>FullTextSearchMatchWholePhrase</maml:name> <maml:description> <maml:para>If SearchString is provided, this searches for the whole phrase and does not split the string into words.</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: FullTextSearchAttributeValues --> <command:parameter required="false" globbing="false" pipelineInput="false" position="16"> <maml:name>FullTextSearchAttributeValues</maml:name> <maml:description> <maml:para>If SearchString is provided, this searches in the attribute values rather than in the file content.</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: DocumentUpdatedAfter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="17"> <maml:name>DocumentUpdatedAfter</maml:name> <maml:description> <maml:para>Document 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>01/01/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: DocumentUpdatedBefore --> <command:parameter required="false" globbing="false" pipelineInput="false" position="18"> <maml:name>DocumentUpdatedBefore</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>01/01/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: JustThisFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <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="3"> <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="4"> <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="5"> <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="6"> <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="7"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Hashtable of attribute search parameters. 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: States --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>States</maml:name> <maml:description> <maml:para>List of 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: FileUpdatedAfter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>FileUpdatedAfter</maml:name> <maml:description> <maml:para>File 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>01/01/0001 12:00:00 AM</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>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="1"> <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: JustThisFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <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="3"> <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="4"> <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="5"> <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="6"> <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="7"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Hashtable of attribute search parameters. 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: States --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>States</maml:name> <maml:description> <maml:para>List of 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: FileUpdatedAfter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>FileUpdatedAfter</maml:name> <maml:description> <maml:para>File 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>01/01/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: FileUpdatedBefore --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>FileUpdatedBefore</maml:name> <maml:description> <maml:para>File 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>01/01/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: ColumnsToReturn --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>ColumnsToReturn</maml:name> <maml:description> <maml:para>List of columns to populate in search results (not validated).</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReturnDataTable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="12"> <maml:name>ReturnDataTable</maml:name> <maml:description> <maml:para>If set, will return a data table. Default is to return an arrary of document objects.</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: PopulatePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>PopulatePath</maml:name> <maml:description> <maml:para>Populate path on return objects/table. Will degrade performance somewhat.</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: FullTextSearchMatchAllWords --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>FullTextSearchMatchAllWords</maml:name> <maml:description> <maml:para>If SearchString is provided, this will split the string into words at the spaces and require the content to contain all of the words in the string. Otherwise, will match on 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: FullTextSearchMatchWholePhrase --> <command:parameter required="false" globbing="false" pipelineInput="false" position="15"> <maml:name>FullTextSearchMatchWholePhrase</maml:name> <maml:description> <maml:para>If SearchString is provided, this searches for the whole phrase and does not split the string into words.</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: FullTextSearchAttributeValues --> <command:parameter required="false" globbing="false" pipelineInput="false" position="16"> <maml:name>FullTextSearchAttributeValues</maml:name> <maml:description> <maml:para>If SearchString is provided, this searches in the attribute values rather than in the file content.</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: DocumentUpdatedAfter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="17"> <maml:name>DocumentUpdatedAfter</maml:name> <maml:description> <maml:para>Document 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>01/01/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: DocumentUpdatedBefore --> <command:parameter required="false" globbing="false" pipelineInput="false" position="18"> <maml:name>DocumentUpdatedBefore</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>01/01/0001 12:00:00 AM</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usages for searching for documents. #Get the active documents in this folder tree where the file name pattern matches %.pdf, is in one of the listed states and return the columns specified Get-PWDocumentsBySearchWithReturnColumns -FolderPath "Test 6\Projects 2" -Filename '%.pdf' -States "Draft","Pending Approval" -ColumnsToReturn "PercentComplete","DrawingNumber" #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 Get-PWDocumentsBySearchWithReturnColumns -FolderPath "Test 6\Projects 2" -Filename '%.pdf' -GetVersionsToo -States "Draft","Pending Approval" -SearchString "Primary" -ColumnsToReturn "PercentComplete","DrawingNumber" #Get the active documents in this folder tree matching these attributes where the file was updated after the given date Get-PWDocumentsBySearchWithReturnColumns -FolderPath "Test 6\Projects 2" -Attributes @{Name = 'Value'; Name2 = 'Value2' } -FileUpdatedAfter 2017-01-01 #Get the active documents in this folder tree matching these attributes where the file was updated between the given dates Get-PWDocumentsBySearchWithReturnColumns -FolderPath "Test 6\Projects 2" -Attributes @{Name = 'Value'; Name2 = 'Value2' } -FileUpdatedAfter 2017-01-01 -FileUpdatedBefore 2017-02-01 #Get the active documents in this folder tree where the file name pattern matches %.pdf, is in one of the listed states and return the columns specified in a DataTable Get-PWDocumentsBySearchWithReturnColumns -FolderPath "Test 6\Projects 2" -Filename '%.pdf' -States "Draft","Pending Approval" -ColumnsToReturn "PercentComplete","DrawingNumber" -ReturnDataTable</dev:code> </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 and from Export-PWDocuments. NOTE: Does not support version stack imports where the document name varies through the stack. Will handle file name variation.</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: CreateMissingFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>CreateMissingFiles</maml:name> <maml:description> <maml:para>Set to create missing files. Missing files will be skipped otherwise.</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: 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> <!-- Parameter: SkipAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>SkipAuditTrail</maml:name> <maml:description> <maml:para>Skip 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: WriteBackLinks --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>WriteBackLinks</maml:name> <maml:description> <maml:para>Write back link to input spreadsheet (do not use on really big files).</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: DeleteFilesOnImport --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>DeleteFilesOnImport</maml:name> <maml:description> <maml:para>Set to delete files after import.</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> <!-- Parameter: SkipAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>SkipAuditTrail</maml:name> <maml:description> <maml:para>Skip 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: WriteBackLinks --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>WriteBackLinks</maml:name> <maml:description> <maml:para>Write back link to input spreadsheet (do not use on really big files).</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: DeleteFilesOnImport --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>DeleteFilesOnImport</maml:name> <maml:description> <maml:para>Set to delete files after import.</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: CreateMissingFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>CreateMissingFiles</maml:name> <maml:description> <maml:para>Set to create missing files. Missing files will be skipped otherwise.</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> <dev:code>#Example usage for reporting on documents. #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. #Creates versions of duplicate files with the given switch. Import-PWDocumentsBySpreadsheet -InputFile "c:\import\import.xlsx" -TargetProjectWiseFolder "Target A\Folder 1" -DefaultStorage Store01 -VersionIfExists #Will import files from spreadsheet. Shows use of pipeline. Import-PWDocumentsBySpreadsheet -InputFile "c:\import\import.xlsx" -TargetProjectWiseFolder "Target A\Folder 1" -DefaultStorage Store01 -DefaultWorkflow Normal | Set-PWDocumentState -State "Imported"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Copy-PWDocumentSecurity --> <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-PWDocumentSecurity</command:name> <command:verb>Copy</command:verb> <command:noun>PWDocumentSecurity</command:noun> <maml:description> <maml:para>Copy document security from a template document onto one or more input documents.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Copy-PWDocumentSecurity</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: SecurityTemplate --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>SecurityTemplate</maml:name> <maml:description> <maml:para>Source document object (security template).</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: ApplyToVersions --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>ApplyToVersions</maml:name> <maml:description> <maml:para>Apply the security to versions of the input 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> </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: SecurityTemplate --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>SecurityTemplate</maml:name> <maml:description> <maml:para>Source document object (security template).</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: ApplyToVersions --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>ApplyToVersions</maml:name> <maml:description> <maml:para>Apply the security to versions of the input 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> </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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Source document object (security template).</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>Apply the security to versions of the input documents.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$templateDoc = Get-PWDocumentsBySearch -FolderPath "Template Documents\Folder 1" -Name "Security Template.dgn" $targetDocs = Get-PWDocumentsBySearch -FolderPath "Target Documents\Folder 1" Copy-PWDocumentSecurity $targetDocs -SecurityTemplate $templateDoc -ApplyToVersions</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Show-PWDocumentSelectionDialog --> <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-PWDocumentSelectionDialog</command:name> <command:verb>Show</command:verb> <command:noun>PWDocumentSelectionDialog</command:noun> <maml:description> <maml:para>Select one or more ProjectWise Documents from a dialog.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InitialFolderPath --> <command:syntaxItem> <maml:name>Show-PWDocumentSelectionDialog</maml:name> <!-- Parameter: InitialFolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>InitialFolderPath</maml:name> <maml:description> <maml:para>Initial folder path (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: FileExtension --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FileExtension</maml:name> <maml:description> <maml:para>File extension filter (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: InitialFolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>InitialFolderPath</maml:name> <maml:description> <maml:para>Initial folder path (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: FileExtension --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FileExtension</maml:name> <maml:description> <maml:para>File extension filter (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> <!-- OutputType: ProjectWiseDocument[] --> <command:returnValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$docs = Show-PWDocumentSelectionDialog 'UDOT\Kofax\GAX\2013' -FileExtension tif Set-PWDocumentFinalStatus $docs</dev:code> </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 info from a SQLite archive container generated by Export-PWDocumentsToArchive.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Import folders, files, metadata, and audit trail from a SQLite database.</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. If not included, the parent folder's storage area is 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: 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> <!-- Parameter: RetainFileNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetainFileNames</maml:name> <maml:description> <maml:para>When included, if versions of being created, the filename of the source file will NOT overwrite the existing file name.</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: SkipDocumentAttributeUpdate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipDocumentAttributeUpdate</maml:name> <maml:description> <maml:para>When included, document attributes will NOT be updated.</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: SkipSecondaryAttributeUpdate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipSecondaryAttributeUpdate</maml:name> <maml:description> <maml:para>When included, a secondary attempt to update individual document attributes will not be performed.</maml:para> <maml:para>This secondary attempt to update document attributes ONLY occurs when the initial attempt to update ALL document attributes fails.</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. If not included, the parent folder's storage area is 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: 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> <!-- Parameter: SkipDocumentAttributeUpdate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipDocumentAttributeUpdate</maml:name> <maml:description> <maml:para>When included, document attributes will NOT be updated.</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: SkipSecondaryAttributeUpdate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipSecondaryAttributeUpdate</maml:name> <maml:description> <maml:para>When included, a secondary attempt to update individual document attributes will not be performed.</maml:para> <maml:para>This secondary attempt to update document attributes ONLY occurs when the initial attempt to update ALL document attributes fails.</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: RetainFileNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RetainFileNames</maml:name> <maml:description> <maml:para>When included, if versions of being created, the filename of the source file will NOT overwrite the existing file name.</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> <dev:code>Will import documents from an archive container. Import-PWDocumentsFromArchive -InputFile 'c:\export\export.sqlite' -TargetFolder "Imports\From Disk" -DefaultStorage Storage01 -ReplaceIfExists</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Will import documents from an archive container. Uses a local folder and the document attributes will not be updated. Import-PWDocumentsFromArchive -InputFile 'c:\export\export.sqlite' -TargetFolder "Imports\From Disk" -LocalFolder 'd:\temp' -SkipDocumentAttributeUpdate -ReplaceIfExists</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-PWDocumentsFromZip --> <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-PWDocumentsFromZip</command:name> <command:verb>Import</command:verb> <command:noun>PWDocumentsFromZip</command:noun> <maml:description> <maml:para>Export files to a zip file.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFileName --> <command:syntaxItem> <maml:name>Import-PWDocumentsFromZip</maml:name> <!-- Parameter: InputFileName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFileName</maml:name> <maml:description> <maml:para>File 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: ParentPWFolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ParentPWFolderPath</maml:name> <maml:description> <maml:para>This will be the new parent 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: StorageArea --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>StorageArea</maml:name> <maml:description> <maml:para>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: Environment --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Environment for new folders (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: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Workflow for new folders (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: State --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>State</maml:name> <maml:description> <maml:para>State for new documents (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: InputFileName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFileName</maml:name> <maml:description> <maml:para>File 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: ParentPWFolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ParentPWFolderPath</maml:name> <maml:description> <maml:para>This will be the new parent 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: StorageArea --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>StorageArea</maml:name> <maml:description> <maml:para>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: Environment --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Environment for new folders (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: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Workflow for new folders (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: State --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>State</maml:name> <maml:description> <maml:para>State for new documents (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>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>File on disk for output.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>This will be the new parent folder.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Storage area (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>Environment for new folders (optional).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Workflow for new folders (optional).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>State for new documents (optional).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Gets an array of documents, exports them to a zip file, sets final status on each. Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" -DocumentName '%.pdf' -GetVersionsToo | Export-PWDocumentFilesToZip -OutputFile c:\export\ProjectPDFs.zip | Set-PWDocumentFinalStatus </dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWDocumentSheet --> <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-PWDocumentSheet</command:name> <command:verb>Remove</command:verb> <command:noun>PWDocumentSheet</command:noun> <maml:description> <maml:para>Remove-PWDocumentSheet removes all attribute sheets associated with a document(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove-PWDocumentSheet removes all attribute sheets associated with a document(s) passed via the pipeline. The document objects passed will be returned.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>Remove-PWDocumentSheet</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 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> </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 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> </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 to feed pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>The following will remove the attribute sheets from all documents passed via the pipeline. Get-PWDocumentsBySearch -FolderPath "Projects\Test" | Remove-PWDocumentSheet -Verbose</dev:code> </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, free or Import exported 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. The cmdlet will determine if a document is CheckedOut or Exported and either checkin or import the document. 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> <dev:code>#Example usage for checking in document(s). #Get the documents in the folder where filename like *.dgn and check them in. Get-PWDocumentsBySearch -FolderPath 'Microstation J' -FileName '%.dgn' | CheckIn-PWDocumentsOrFree | Select-Object FileName #Should check in all the checked out documents passed to the cmdlet</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Example usage for freeing a document(s). #Get the documents in the folder where filename like *.dgn and check them in. Get-PWDocumentsBySearch -FolderPath 'Microstation J' -FileName '%.dgn' | CheckIn-PWDocumentsOrFree -Free | Select-Object FileName #Should free all the checked out documents passed to the cmdlet</dev:code> </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> <dev:code>#Setting all the documents in a folder to a given state. #Get all the documents in this folder and set them to state 'Completed' #Skipping intermediate states, changing the states of old version, changing the states of documents with final status, #and changing the status of checked out and exported documents. User must be administator for special switches to work. Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" -GetVersionsToo -JustThisFolder | Set-PWDocumentState -State 'Completed' -SkipIntermediateStates -ChangeVersionStates -ChangeFinalStatusStates -IgnoreStatus</dev:code> </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> <!-- Parameter: NoAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>NoAuditTrail</maml:name> <maml:description> <maml:para>Set to exclude 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: ExcludeSecondaryAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ExcludeSecondaryAuditTrail</maml:name> <maml:description> <maml:para>Set to exclude secondary audit trail. Sometimes required for performance reasons.</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> <!-- Parameter: NoAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>NoAuditTrail</maml:name> <maml:description> <maml:para>Set to exclude 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: ExcludeSecondaryAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ExcludeSecondaryAuditTrail</maml:name> <maml:description> <maml:para>Set to exclude secondary audit trail. Sometimes required for performance reasons.</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> <dev:code>#Will export documents returned by the listed saved searches to an archive container. #SQLiteStudio seems like an adequate managment tool (http://sqlitestudio.pl/?act=download) for the resulting container. Export-PWDocumentsToArchive -OutputFolder c:\export -Searches "60% Complete;80% Complete;90% Complete" #Will export documents in given folder to an archive container. Export-PWDocumentsToArchive -OutputFolder c:\export -ProjectWiseFolder "Source A\Subfolder 1"</dev:code> </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> <!-- Parameter: NoAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>NoAuditTrail</maml:name> <maml:description> <maml:para>Don't include 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: ExcludeSecondaryAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>ExcludeSecondaryAuditTrail</maml:name> <maml:description> <maml:para>Don't include secondary audit trail records. Sometimes required for 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> </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> <!-- Parameter: NoAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>NoAuditTrail</maml:name> <maml:description> <maml:para>Don't include 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: ExcludeSecondaryAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>ExcludeSecondaryAuditTrail</maml:name> <maml:description> <maml:para>Don't include secondary audit trail records. Sometimes required for 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> </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> <dev:code>#Will report on the documents returned by the saved search to an DataSet. Export-PWDocumentsToDataSet -SearchName "60% Complete" #Will report on documents in given folder treee to a DataSet. Export-PWDocumentsToDataSet -ProjectWiseFolder "Source A\Subfolder 1" #DataSet output handling in PowerShell $ds=Export-PWDocumentsToDataSet -ProjectWiseFolder "Add Test Docs 01" foreach ($table in $ds.Tables) { Write-Host "TableName: $($table.TableName)" foreach ($column in $table.Columns) { write-Host "ColumnName: $($column.ColumnName), ColumnType: $($column.DataType)" } foreach ($row in $table.Rows) { foreach ($column in $table.Columns) { write-Host "$($column.ColumnName): $($row[$($column.ColumnName)])" } } } #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. $ds=Export-PWDocumentsToDataSet -ProjectWiseFolder "Add Test Docs 01" $cn = new-object System.Data.SqlClient.SqlConnection("Data Source=brumd09515rem;User ID=sa;Password=pwd;Initial Catalog=BulkCopyTest"); $cn.Open() $bc = new-object ("System.Data.SqlClient.SqlBulkCopy") $cn $bc.DestinationTableName = "dbo.General_Documents_Table" $dtable=$ds.Tables["General_Documents_Table"] $bc.WriteToServer($dtable) $cn.Close()</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Save-PWDocumentsToDataTable --> <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-PWDocumentsToDataTable</command:name> <command:verb>Save</command:verb> <command:noun>PWDocumentsToDataTable</command:noun> <maml:description> <maml:para>Create an arry of data tables suitable for output to Excel or SQLite from an array of document objects like that returned from Get-PWDocumentsBySearch.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create an arry of data tables suitable for output to Excel or SQLite from an array of document objects like that returned from Get-PWDocumentsBySearch.</maml:para> <maml:para>Optionally include audit trail and optionall set date range for audit trail.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Save-PWDocumentsToDataTable</maml:name> <!-- Parameter: InputDocuments --> <command:parameter required="true" 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: IncludeAttributes --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>IncludeAttributes</maml:name> <maml:description> <maml:para>Include this switch to include attributes in the returned tables.</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="true (ByValue)" position="2"> <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: AuditTrailRecordsStart --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <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>01/01/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: AuditTrailRecordsEnd --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <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>01/01/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludeSecondaryAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>ExcludeSecondaryAuditTrail</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> </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>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: IncludeAttributes --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>IncludeAttributes</maml:name> <maml:description> <maml:para>Include this switch to include attributes in the returned tables.</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="true (ByValue)" position="2"> <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: AuditTrailRecordsStart --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <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>01/01/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: AuditTrailRecordsEnd --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <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>01/01/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludeSecondaryAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>ExcludeSecondaryAuditTrail</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> </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:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Include this switch to include attributes in the returned tables.</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>Include this switch to include the audit trail.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If set, include audit trail records newer than this date.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>If set, include audit trail records older than this date.</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>Include this switch to include the audit trail.</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> <dev:code>#Get documents from search, Convert to an array of data tables including attributes and audit trail, Create XLSX file from DataTables. $docs = Get-PWDocumentsBySearch -SearchName "All PDFs" $dts = Save-PWDocumentsToDataTable -IncludeAuditTrail -IncludeAttributes New-XLSXWorkbook $dts -OutputFileName d:\Export\AllPDFs.xlsx #Output to SQLite database. foreach ($dt in $ds) { $dt2 = $dt.Copy() Export-DataTableToSQLiteDB -SourceDataTable $dt2 -OutputFolder D:\DMOutput7 -OutputFileName SAR04.sqlite -Append }</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWDocumentsToEmptyFoldersForAzure --> <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-PWDocumentsToEmptyFoldersForAzure</command:name> <command:verb>Add</command:verb> <command:noun>PWDocumentsToEmptyFoldersForAzure</command:noun> <maml:description> <maml:para>Azure Blob Storage Folders are required to contain a file or they get cleaned up.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Azure Blob Storage Folders are required to contain a file or they get cleaned up.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Storage --> <command:syntaxItem> <maml:name>Add-PWDocumentsToEmptyFoldersForAzure</maml:name> <!-- Parameter: Storage --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Storage</maml:name> <maml:description> <maml:para>Search for folders using 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: AlternateStorage --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>AlternateStorage</maml:name> <maml:description> <maml:para>Provide alternate storage area in order to fix missing 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: FileName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Dummy filename that will be used. Defaults to .azureignore.</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>.azureignore</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Storage --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Storage</maml:name> <maml:description> <maml:para>Search for folders using 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: AlternateStorage --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>AlternateStorage</maml:name> <maml:description> <maml:para>Provide alternate storage area in order to fix missing 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: FileName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Dummy filename that will be used. Defaults to .azureignore.</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>.azureignore</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>Search for folders using this storage area.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Provide alternate storage area in order to fix missing folders.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Dummy filename that will be used. Defaults to .azureignore.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Add-PWDocumentToEmptyFolderForAzure "Azure Blob Storage"</dev:code> </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> <!-- Parameter: IncludeVersions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>IncludeVersions</maml:name> <maml:description> <maml:para>Set this to include document versions with the copy process. If not set, document versions will not 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: CopyReferenceRelationships --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>CopyReferenceRelationships</maml:name> <maml:description> <maml:para>Set this to copy the reference relations.</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: IncludeVersions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>IncludeVersions</maml:name> <maml:description> <maml:para>Set this to include document versions with the copy process. If not set, document versions will not 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: CopyReferenceRelationships --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>CopyReferenceRelationships</maml:name> <maml:description> <maml:para>Set this to copy the reference relations.</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> <dev:code>#Get the documents in the given path and copy them to a target folder Get-PWDocumentsBySearch -FolderPath 'Import\Test' -FileName '02_%.pdf'| Copy-PWDocumentsToFolder -TargetFolderPath 'New\Folder\Path' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Get the documents in the given path and copy them to a target folder. Create versions if documents exist. Get-PWDocumentsBySearch -FolderPath 'Import\Test' -FileName '02_%.pdf'| Copy-PWDocumentsToFolder -TargetFolderPath 'New\Folder\Path' -CreateVersion -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>#Get the documents in the given path and copy them to a target folder, including any document versions. Get-PWDocumentsBySearch -FolderPath 'Import\Test' -FileName '02_%.pdf'| Copy-PWDocumentsToFolder -TargetFolderPath 'New\Folder\Path' -IncludeVersions -Verbose</dev:code> </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 skipped.</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> <!-- Parameter: PreserveSourceState --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>PreserveSourceState</maml:name> <maml:description> <maml:para>(Obsolete) argument is ignored. Preserved for backward compatibility.</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 skipped.</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> <!-- Parameter: PreserveSourceState --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>PreserveSourceState</maml:name> <maml:description> <maml:para>(Obsolete) argument is ignored. Preserved for backward compatibility.</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> <dev:code># Get the documents in the given path and move them to a target folder. Document states will be preserved in the target folder. Get-PWDocumentsBySearch -FolderPath 'Import\Test' -FileName '02_%.pdf'| Move-PWDocumentsToFolder -TargetFolderPath 'New\Folder\Path'</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code># Get the documents in the folder and move them to a target folder. Do not preserve the source state for each document. $pwDocs = Get-PWDocumentsBySearch -FolderID 70383 -JustThisFolder $pwDocsMoved = Move-PWDocumentsToFolder -InputDocument $pwDocs -TargetFolderPath 'PowerShell\PowerShell_Target' -DoNotPreserveState -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code># Get the documents in the folder and move them to a target folder. Create versions if documents exist in target. Document states will be preserved in the target folder. Except for any new document versions. $pwDocs = Get-PWDocumentsBySearch -FolderID 70383 -JustThisFolder $pwDocsMoved = Move-PWDocumentsToFolder -InputDocument $pwDocs -TargetFolderPath 'PowerShell\PowerShell_Target' -CreateVersion -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code># Get the documents in the folder and move them to a target folder. Create versions if documents exist in target. Document states will be preserved in the target folder, including new document versions. $pwDocs = Get-PWDocumentsBySearch -FolderID 70383 -JustThisFolder $pwDocsMoved = Move-PWDocumentsToFolder -InputDocument $pwDocs -TargetFolderPath 'PowerShell\PowerShell_Target' -CreateVersion -PreserveSourceState -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWDocumentStorageToMatchFolder --> <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-PWDocumentStorageToMatchFolder</command:name> <command:verb>Update</command:verb> <command:noun>PWDocumentStorageToMatchFolder</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-PWDocumentStorageToMatchFolder</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: JustOne --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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: 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: JustOne --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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:returnValues /> </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="true" globbing="false" pipelineInput="true (ByValue)" 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>-1</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="true" globbing="false" pipelineInput="true (ByValue)" 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>-1</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:inputType> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Hashtable of attributes. Hashtable in PowerShell looks like this @{Name = 'Value'; Name2 = 'Value2' }</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code># Create 5 abstract documents using document code populated with the passed default attribute values Get-PWFolders -FolderPath 'Replicated\Project 01' | Add-PWDocumentsWithCode -Attributes @{ ProjectNumber = 'BSI400'; AreaShort = 'RW'; DocumentTypeShort = '2DM'; LevelShort = 'NA' } -NumberOfDocuments 5 # 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 Get-PWFolders -FolderPath 'Replicated\Project 01' | Add-PWDocumentsWithCode -Attributes @{ ProjectNumber = 'BSI400'; AreaShort = 'RW'; DocumentTypeShort = '2DM'; LevelShort = 'NA' } -NumberOfDocuments 5 | Update-PWDocumentFile -NewFilePathName 'C:\temp\dummy.txt'</dev:code> </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> <dev:code>#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 $printers=Get-WMIObject Win32_Printer $defprinter01=Get-WMIObject Win32_Printer | Where{$_.Default -eq $true} $defprinter02=Get-WMIObject Win32_Printer | Where{$_.Name -eq "HP Laser Jet"} $defprinter02.SetDefaultPrinter() Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder' -FileName %.pdf | Submit-PWPDFPrint -Verbose $defprinter01.SetDefaultPrinter()</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWDocumentUserListAccess --> <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-PWDocumentUserListAccess</command:name> <command:verb>Remove</command:verb> <command:noun>PWDocumentUserListAccess</command:noun> <maml:description> <maml:para>Remove userlist access for one or more input documents.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Remove-PWDocumentUserListAccess</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: UserList --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>UserList</maml:name> <maml:description> <maml:para>UserList to apply access 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> </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: UserList --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>UserList</maml:name> <maml:description> <maml:para>UserList to apply access 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> </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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>UserList to apply access for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$targetDocs = Get-PWDocumentsBySearch -FolderPath "Target Documents\Folder 1" Remove-PWDocumentUserListAccess $targetDocs -UserList 'Drafters'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWDocumentUserListAccess --> <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-PWDocumentUserListAccess</command:name> <command:verb>Set</command:verb> <command:noun>PWDocumentUserListAccess</command:noun> <maml:description> <maml:para>Set userlist access for one or more input documents.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Set-PWDocumentUserListAccess</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: UserList --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>UserList</maml:name> <maml:description> <maml:para>UserList to apply access 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: Access --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Access</maml:name> <maml:description> <maml:para>Access 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: ApplyToVersions --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>ApplyToVersions</maml:name> <maml:description> <maml:para>Apply the security to versions of the input 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> </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: UserList --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>UserList</maml:name> <maml:description> <maml:para>UserList to apply access 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: Access --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Access</maml:name> <maml:description> <maml:para>Access 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: ApplyToVersions --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>ApplyToVersions</maml:name> <maml:description> <maml:para>Apply the security to versions of the input 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> </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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>UserList to apply access for.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Access 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:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Apply the security to versions of the input documents.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$targetDocs = Get-PWDocumentsBySearch -FolderPath "Target Documents\Folder 1" Set-PWDocumentUserListAccess $targetDocs -UserList 'Drafters' -Access 'r','w','fr','fw' Set-PWDocumentUserListAccess $targetDocs -UserList 'Project Managers' -Access 'na'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWDocumentUserListAccess2 --> <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-PWDocumentUserListAccess2</command:name> <command:verb>Remove</command:verb> <command:noun>PWDocumentUserListAccess2</command:noun> <maml:description> <maml:para>Remove userlist access for one or more input documents.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Remove-PWDocumentUserListAccess2</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: UserList --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>UserList</maml:name> <maml:description> <maml:para>UserList to apply access 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> </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: UserList --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>UserList</maml:name> <maml:description> <maml:para>UserList to apply access 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> </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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>UserList to apply access for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$targetDocs = Get-PWDocumentsBySearch -FolderPath "Target Documents\Folder 1" Remove-PWDocumentUserListAccess $targetDocs -UserList 'Drafters'</dev:code> </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> <dev:code>#Search for documents and version them to version A. Get-PWDocumentsBySearch -SearchName "Documents in Released State" | New-PWDocumentVersion -VersionString A #Search for documents in folder version to next version. Get-PWDocumentsBySearch -FolderPath "Project A\Files to Version" | New-PWDocumentVersion</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-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>Set-PWDocumentVersion</command:name> <command:verb>Set</command:verb> <command:noun>PWDocumentVersion</command:noun> <maml:description> <maml:para>Sets the Version string of a document.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets the Version string a document.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Set-PWDocumentVersion</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 like that 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: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Version</maml:name> <maml:description> <maml:para>New 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: 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 like that 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: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Version</maml:name> <maml:description> <maml:para>New 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>Array of document objects like that from Get-PWDocumentsBySearch.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Sets the Version string for the specified documents. $docs = Show-PWDocumentSelectionDialog -FileExtension 'dgn' -Verbose Set-PWDocumentVersion -InputDocuments $docs -Version '1.7'</dev:code> </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> <dev:code>#Get the documents in the given path and delete old versions of the documents up to the "number of versions to keep" Get-PWDocumentsBySearch -FolderPath 'Import\Test' | Remove-PWDocumentVersions -NumberOfVersionsToKeep 3</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWDocumentViaWSG --> <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-PWDocumentViaWSG</command:name> <command:verb>New</command:verb> <command:noun>PWDocumentViaWSG</command:noun> <maml:description> <maml:para>Use ProjectWise Connector to upload a file via WSG. Might be useful when ProjectWise client is not installed or port 5800 connection is not available.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-PWDocumentViaWSG</maml:name> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>Token (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: WSGURL --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>WSGURL</maml:name> <maml:description> <maml:para>WSG URL (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: Datasource --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Datasource</maml:name> <maml:description> <maml:para>Datasource 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: Folder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Target Folder Path (Required). Will be created if necessary.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceURL --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>SourceURL</maml:name> <maml:description> <maml:para>URL of file to upload (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: FileName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>FileName</maml:name> <maml:description> <maml:para>File name (Optional). Provide if you know it particularly if URL is encoded.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Title --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="6"> <maml:name>Title</maml:name> <maml:description> <maml:para>Document description (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: Email --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="7"> <maml:name>Email</maml:name> <maml:description> <maml:para>Provide email to get an email with a link to download the file from ProjectWise (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: SuppressMakeUnique --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="8"> <maml:name>SuppressMakeUnique</maml:name> <maml:description> <maml:para>Web service appends a suffix to the filename/document name by default to ensure uniqueness (Optional).</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: Token --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>Token (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: WSGURL --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>WSGURL</maml:name> <maml:description> <maml:para>WSG URL (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: Datasource --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Datasource</maml:name> <maml:description> <maml:para>Datasource 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: Folder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>Folder</maml:name> <maml:description> <maml:para>Target Folder Path (Required). Will be created if necessary.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SourceURL --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>SourceURL</maml:name> <maml:description> <maml:para>URL of file to upload (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: FileName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>FileName</maml:name> <maml:description> <maml:para>File name (Optional). Provide if you know it particularly if URL is encoded.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Title --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="6"> <maml:name>Title</maml:name> <maml:description> <maml:para>Document description (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: Email --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="7"> <maml:name>Email</maml:name> <maml:description> <maml:para>Provide email to get an email with a link to download the file from ProjectWise (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: SuppressMakeUnique --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="8"> <maml:name>SuppressMakeUnique</maml:name> <maml:description> <maml:para>Web service appends a suffix to the filename/document name by default to ensure uniqueness (Optional).</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>Token (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>WSG URL (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>Datasource Name (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 Path (Required). Will be created if necessary.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>URL of file to upload (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>File name (Optional). Provide if you know it particularly if URL is encoded.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Document description (Optional).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Provide email to get an email with a link to download the file from ProjectWise (Optional).</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>Web service appends a suffix to the filename/document name by default to ensure uniqueness (Optional).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$encrytedPassword = Read-Host -Prompt "Enter Password:" -AsSecureString $token = Get-PWConnectorToken -UserName "user.name" -Password $encryptedPassword $params = @{ Token=$token WSGURL="https://server-ws.bentley.com/ws/" Datasource="decide-pwce-us.bentley.com:decide-pwce-us-10" Folder="PowerShell Connector\Cmdlet" Email="user.name@email.com" SourceURL="https://1drv.ms/u/s!ArLe7rEb_guVgpRjGIN_5DcJkLhD2Q" Title="Upload from One Drive via PowerShell" Filename="test20180209a.zip" SuppressMakeUnique=$true } New-PWDocumentViaWSG @params</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Equivalent to first example, but uses Invoke-RestMethod instead of New-PWDocumentViaWSG $encrytedPassword = Read-Host -Prompt "Enter Password:" -AsSecureString $token = Get-PWConnectorToken -UserName "user.name" -Password $encryptedPassword $uploadBody = ConverTo-Json @{ Token=$token WSGURL="https://server-ws.bentley.com/ws/" Datasource="decide-pwce-us.bentley.com:decide-pwce-us-10" Folder="PowerShell Connector\REST Upload" Email="user.name@email.com" SourceURL="https://1drv.ms/u/s!ArLe7rEb_guVgpRjGIN_5DcJkLhD2Q" Title="Upload from One Drive via PowerShell and REST" Filename="test20180209b.zip" MakeUnique=$false } $urlForUpload="https://projectwiseconnector.azurewebsites.net/api/PostFileToDatasource?code=24g5wGbJOf/k5bCla0ddjOpu06SNApVpvvMOl60tfQ0bbrDoxnGwPA==" Invoke-RestMethod -ContentType "Application/Json" -Method Post -Body $uploadBody -Uri $urlForUpload</dev:code> </command:example> </command:examples> </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> <dev:code>#Example usage for Get-PWDSConfigEntry. #Will return information for all datasources configured on local system. Get-PWDSConfigEntry #Will return information for all datasources configured on specified server by servername. Get-PWDSConfigEntry -Server 'PWConnect' #Will return information for all datasources configured on specified server by FQDN. Get-PWDSConfigEntry -Server 'Alpo.Bentley.Com' #Will return information for all datasources configured on specified server by IPAddress. Get-PWDSConfigEntry -Server '192.168.1.5' #Will return information for specified datasource. Get-PWDSConfigEntry -DatasourceName 'PWConnectEdition' #Will return information for specified datasource configured on specified server by FQDN. Get-PWDSConfigEntry -Server 'Alpo.Bentley.Com' -DatasourceName 'PWConnectEdition'</dev:code> </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> <dev:code>#Example usage for setting the ProjectWise current datasource session using the session information passed. Set-PWDSSession -PWDSSession $session</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWEmptyFolders --> <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-PWEmptyFolders</command:name> <command:verb>Remove</command:verb> <command:noun>PWEmptyFolders</command:noun> <maml:description> <maml:para>Delete the empty folders in the given folder path.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: FolderPath --> <command:syntaxItem> <maml:name>Remove-PWEmptyFolders</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. 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: NoRecursion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>NoRecursion</maml:name> <maml:description> <maml:para>If set, will only make one pass to delete empty leaf 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: RemoveRichProjects --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>RemoveRichProjects</maml:name> <maml:description> <maml:para>If set, will also remove rich projects. Otherwise, rich projects will remain even if empty.</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>Folder path. 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: NoRecursion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>NoRecursion</maml:name> <maml:description> <maml:para>If set, will only make one pass to delete empty leaf 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: RemoveRichProjects --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>RemoveRichProjects</maml:name> <maml:description> <maml:para>If set, will also remove rich projects. Otherwise, rich projects will remain even if empty.</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> <dev:code>New-PWFolder "Testing\Remove-PWEmptyFolders\Cmdlet\From\PowerShell" -StorageArea Storage $folders=Get-PWEmptyLeafFolders -FillPaths foreach ($folder in $folders) { $folder.FullPath } Remove-PWEmptyFolders $folders=Get-PWEmptyLeafFolders -FillPaths foreach ($folder in $folders) { $folder.FullPath } Get-PWEmptyLeafFolders -FolderPath "Top Level Folder\Sub-Folder"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWEmptyFoldersFromDatasource --> <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-PWEmptyFoldersFromDatasource</command:name> <command:verb>Remove</command:verb> <command:noun>PWEmptyFoldersFromDatasource</command:noun> <maml:description> <maml:para>Delete all the empty folders from the datasource.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-PWEmptyFoldersFromDatasource</maml:name> <!-- Parameter: NoRecursion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>NoRecursion</maml:name> <maml:description> <maml:para>If set, will only make one pass to delete empty leaf 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: NoRecursion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>NoRecursion</maml:name> <maml:description> <maml:para>If set, will only make one pass to delete empty leaf 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> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Remove-PWEmptyFoldersFromDatasource -NoRecursion</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWEmptyLeafFolders --> <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-PWEmptyLeafFolders</command:name> <command:verb>Get</command:verb> <command:noun>PWEmptyLeafFolders</command:noun> <maml:description> <maml:para>Returns array of empty leaf folders.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWEmptyLeafFolders</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>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>Folder path. Will search whole datasource if not provided and no folders passed in 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: FillPaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FillPaths</maml:name> <maml:description> <maml:para>Fill paths (Slow).</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>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>Folder path. Will search whole datasource if not provided and no folders passed in 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: FillPaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FillPaths</maml:name> <maml:description> <maml:para>Fill paths (Slow).</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>Folders from pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$folders=Get-PWEmptyLeafFolders Get-PWEmptyLeafFolders -FolderPath "Top Level Folder\Sub-Folder"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-PWFolders -FolderPath "Top Level Folder\Sub-Folder" -JustOne | Get-PWEmptyLeafFolders</dev:code> </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> <dev:code>New-PWLogin -DatasourceName server:DSN New-PWEnvironment -EnvironmentName NewEnvironment -TableName t_NewEnvironment -ColumnName DrawingNumber -Interface NewEnvironment -Verbose</dev:code> </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> <maml:description> <maml:para>Clear the environment on a folder or folders by path or folder ID.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: FolderID --> <command:syntaxItem> <maml:name>Clear-PWEnvironmentByFolderPath</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" 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: FolderID --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>FolderID</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: SubFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" 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="false" globbing="false" pipelineInput="true (ByValue)" 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: FolderID --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>FolderID</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: SubFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" 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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$folders=Get-PWFolders -FolderPath 'Top Level\Sub-Folder' foreach ($folder in $folders) {Clear-PWEnvironmentByFolderPath $folder.ProjectID}</dev:code> </command:example> </command:examples> </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> <maml:description> <maml:para>Reset the environment on a folder or folders by path or folder ID.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: FolderID --> <command:syntaxItem> <maml:name>Set-PWEnvironmentByFolderPath</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" 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: FolderID --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>FolderID</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: Environment --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <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="true (ByValue)" 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="false" globbing="false" pipelineInput="true (ByValue)" 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: FolderID --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>FolderID</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: Environment --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <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="true (ByValue)" 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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</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:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$folders=Get-PWFolders -FolderPath 'Top Level\Sub-Folder' foreach ($folder in $folders) {Set-PWEnvironmentByFolderPath $folder.ProjectID -Environment 'Project X'}</dev:code> </command:example> </command:examples> </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. NOTE: Requires that you log out and back in to see the new columns.</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> <maml:description> <maml:para>Name of new 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: 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>Scale 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> <maml:description> <maml:para>Name of new 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: 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>Scale 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> <dev:code>Example usage for adding a new text column to an environment. Add-PWEnvironmentColumn -EnvironmentName 'Default' -ColumnName 'MyNewTextAttribute' -ColumnType 'text' -ColumnWidth 100 This adds a new text column named MyNewTextAttribute with a width of 100 to the 'Default' environment.</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Example usage for adding a new integer column to an environment. Add-PWEnvironmentColumn -EnvironmentName 'Default' -ColumnName 'MyNewIntegerAttribute' -ColumnType 'integer' This adds a new integer column named MyNewIntegerAttribute to the 'Default' environment.</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Example usage for adding a new decimal column to an environment. Add-PWEnvironmentColumn -EnvironmentName 'Default' -ColumnName 'MyNewDecimalAttribute' -ColumnType 'decimal' -ColumnWidth 10 -ColumnScale 2 This adds a new decimal column named MyNewDecimalAttribute with a width of 10 and a scale of 2 to the 'Default' environment.</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>Example usage for adding a new date column to an environment. Add-PWEnvironmentColumn -EnvironmentName 'Default' -ColumnName 'MyNewDateAttribute' -ColumnType 'date' This adds a new date column named MyNewDateAttribute to the 'Default' environment.</dev:code> </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 (column) from one environment to another within the current datasource. NOTE: Requires that you log out and back in to see the new column.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Copies an environment attribute (column) 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> <dev:code>Copy-PWEnvironmentColumn -SourceEnvironmentName 'MySourceEnvironment' -TargetEnvironmentName 'MyTargetEnvironment -ColumnName 'MyAttributeToCopy' -Verbose This copies the MyAttributeToCopy environment attribute from MySourceEnvironment to MyTargetEnvironment.</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-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>Remove-PWEnvironmentColumn</command:name> <command:verb>Remove</command:verb> <command:noun>PWEnvironmentColumn</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-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 containing attribute (column) 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> <!-- 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 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: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment containing attribute (column) 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> <!-- 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 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: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> <dev:code>#Example usage for changing the name of a column in an environment. Update-PWEnvironmentColumnName -Environment Environment_1 -Column Column_1 -NewName Column_2</dev:code> </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> <dev:code>#Example usage for Get-PWEnvironmentColumns. #Will return all columns for the 'Simple' environment within the current datasource. Get-PWEnvironmentColumns -EnvironmentName 'Simple' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWEnvironmentColumnSettings --> <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-PWEnvironmentColumnSettings</command:name> <command:verb>Update</command:verb> <command:noun>PWEnvironmentColumnSettings</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-PWEnvironmentColumnSettings</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: ReadOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ReadOnly</maml:name> <maml:description> <maml:para>Set column to read-only.</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: ReadWrite --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ReadWrite</maml:name> <maml:description> <maml:para>Set column to read-write.</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: Required --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Required</maml:name> <maml:description> <maml:para>Set column to required.</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: NotRequired --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>NotRequired</maml:name> <maml:description> <maml:para>Set column to not required.</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: Unique --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Unique</maml:name> <maml:description> <maml:para>Set column to 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: NotUnique --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>NotUnique</maml:name> <maml:description> <maml:para>Set column to 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> </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: ReadOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ReadOnly</maml:name> <maml:description> <maml:para>Set column to read-only.</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: ReadWrite --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ReadWrite</maml:name> <maml:description> <maml:para>Set column to read-write.</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: Required --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Required</maml:name> <maml:description> <maml:para>Set column to required.</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: NotRequired --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>NotRequired</maml:name> <maml:description> <maml:para>Set column to not required.</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: Unique --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Unique</maml:name> <maml:description> <maml:para>Set column to 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: NotUnique --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>NotUnique</maml:name> <maml:description> <maml:para>Set column to 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> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage to set column to read-only and required. Update-PWEnvironmentColumnSettings -Environment Environment_1 -Column Column_1 -ReadOnly -Required</dev:code> </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> <dev:code>#Example usage for changing the width of a column. Update-PWEnvironmentColumnWidth -Environment Environment_1 -Column Column_1 -NewWidth 256</dev:code> </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> <dev:code>#Example usage for copying data from one column to another in an environment. Update-PWEnvironmentCopyData -Environment Environment_1 -Column Column_1 -TargetColumn Column_2</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Export-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>Export-PWEnvironments</command:name> <command:verb>Export</command:verb> <command:noun>PWEnvironments</command:noun> <maml:description> <maml:para>Export environment attribute definitions to a spreadsheet suitable for use with Import-PWEnvironments.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This is intended to be a smarter and easier to edit format than the AAM file currently used for environment definitions.</maml:para> <maml:para>Column types supported are Text, Int, Numeric and DateTime. All column types will lumped into one of those categories.</maml:para> <maml:para>Document Code Definitions and Interfaces are also exported.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: OutputFileName --> <command:syntaxItem> <maml:name>Export-PWEnvironments</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. Optional. If not provided will output an array of DataTables.</maml:para> </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="2"> <maml:name>Environments</maml:name> <maml:description> <maml:para>Provide environment names to limit output. Otherwise, exports definitions from all environments.</maml: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. Optional. If not provided will output an array of DataTables.</maml:para> </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="2"> <maml:name>Environments</maml:name> <maml:description> <maml:para>Provide environment names to limit output. Otherwise, exports definitions from all environments.</maml: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> <dev:code>Export-PWEnvironments c:\report\environments.xlsx -Environments Simple,Complex Export-PWEnvironments c:\report\environments.xlsx</dev:code> </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> <dev:code>#Example usage for Get-PWEnvironments. #Will return all environments from current datasource. Get-PWEnvironments -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-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>Import-PWEnvironments</command:name> <command:verb>Import</command:verb> <command:noun>PWEnvironments</command:noun> <maml:description> <maml:para>Import and update environments from a spreadsheet generated by Export-PWEnvironments.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This is intended to be a smarter and more flexible alternative to using AAM files to maintain environments.</maml:para> <maml:para>Column type keywords supported are text, int, numeric and datetime.</maml:para> <maml:para>You can update existing environments such as adding attributes by adding lines to the spreadsheet. You can change properties for existing attributes by changing the appropriate columns in the spreadsheet. Triggers, defaults and lookups can be added, modified or removed. Triggering columns can be easily changed. Edit control types, format strings, etc. can all be changed.</maml:para> <maml:para>Interfaces can be added or replaced by changing the Interfaces tab. Interface elements can be added or moved or changed.</maml:para> <maml:para>Document code definitions can be modified or removed. Use the -ApplyDocumentCodeDefintion switch.</maml:para> <maml:para>Adding columns works well with SQL Server and Oracle. If table creation on new environment fails in either SQL Server or Oracle, this probably has to do with a reserved word being used, an invalid column name or an invalid width for a column. Debug by taking the displayed DDL for the new table and executing it in SQL Plus (change the table name). Oracle should tell you the issue in an interactive session as will SQL Server Management Studio. Then, just update the spreadsheet and try again.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFileName --> <command:syntaxItem> <maml:name>Import-PWEnvironments</maml:name> <!-- Parameter: InputFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InputFileName</maml:name> <maml:description> <maml:para>Input file name. Should be file in the format generated by Export-PWEnvironments</maml:para> </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="2"> <maml:name>Environments</maml:name> <maml:description> <maml:para>Provide environment names to limit import. Otherwise, imports all environments in 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: Interfaces --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Interfaces</maml:name> <maml:description> <maml:para>Provide Interface names to limit import. Otherwise, imports all interface definitions in 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: ApplyDocumentCodeDefinition --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ApplyDocumentCodeDefinition</maml:name> <maml:description> <maml:para>Set this switch to replace an existing document code definition (use with caution).</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 file name. Should be file in the format generated by Export-PWEnvironments</maml:para> </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="2"> <maml:name>Environments</maml:name> <maml:description> <maml:para>Provide environment names to limit import. Otherwise, imports all environments in 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: Interfaces --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Interfaces</maml:name> <maml:description> <maml:para>Provide Interface names to limit import. Otherwise, imports all interface definitions in 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: ApplyDocumentCodeDefinition --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ApplyDocumentCodeDefinition</maml:name> <maml:description> <maml:para>Set this switch to replace an existing document code definition (use with caution).</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> <dev:code>Import-PWEnvironments c:\report\environments.xlsx -Environments Simple,Complex</dev:code> </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> <dev:code>#Provide report in SQLite format or XLSX or in a format suitable for insert into SQL Server database. #Will save report to a local SQLite database. #SQLiteStudio seems like a decent managment tool (http://sqlitestudio.pl/?act=download). New-PWEnvironmenstReport -OutputFileName c:\report\environments.db #Will save report to a local XLSX file. Just report on one environment. New-PWEnvironmentsReport -OutputFileName c:\report\stats.xlsx -Environment Titleblock</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Save-PWEnvironmentViewScript --> <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-PWEnvironmentViewScript</command:name> <command:verb>Save</command:verb> <command:noun>PWEnvironmentViewScript</command:noun> <maml:description> <maml:para>Build view script.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Save-PWEnvironmentViewScript</maml:name> <!-- Parameter: ScriptPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ScriptPath</maml:name> <maml:description> <maml:para>Script name to generate.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EnvironmentName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment to build view script 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: EnvironmentName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment to build view script 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: ScriptPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ScriptPath</maml:name> <maml:description> <maml:para>Script name to generate.</maml: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> <dev:code>#Will build script for environment views. Save-PWEnvironmentViewScript -EnvironmentName 'Simple' -ScriptName c:\temp\CreateViews.sql Save-PWEnvironmentViewScript -ScriptName c:\temp\CreateAllViews.sql</dev:code> </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> <dev:code>Get-PWFolders -FolderPah 'Top Level\Sub-Folder' | Get-PWManagedWorkspaces</dev:code> </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: ConnectedProjectId --> <command:syntaxItem> <maml:name>Add-PWExternalUsersToConnectedProject</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: ConnectedProjectId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>Connected Project ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Roles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>Roles</maml:name> <maml:description> <maml:para>Array of roles.</maml:para> </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="2"> <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="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>DEPRECATED -- use Token instead.</maml:para> </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>DEPRECATED -- use Token instead.</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: Token --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>Token</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> </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: ConnectedProjectId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>Connected Project ID.</maml:para> </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="2"> <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="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>DEPRECATED -- use Token instead.</maml:para> </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>DEPRECATED -- use Token instead.</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: Token --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>Token</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: Roles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>Roles</maml:name> <maml:description> <maml:para>Array of roles.</maml: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> <dev:code>#Example usage for adding an external user to a CONNECTED project. Add-PWExternalUsersToConnectedProject -FolderPath "PWPS Connected Project Test 6\Projects 2\Project A" -ExternalUsers address1@external.com,address2@external.com,address3@external.com</dev:code> </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> <dev:code>Get-PWFileCheckSumReport -FolderPath 'Top Level\Sub-Folder' -OutputReportName c:\temp\CheckSumReport.xlsx Get-PWFileCheckSumReport -SearchName 'Top Level\Sub-Folder\Search 01' -OutputReportName c:\temp\CheckSumReport.xlsx -Personal</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFileHash --> <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-PWFileHash</command:name> <command:verb>Get</command:verb> <command:noun>PWFileHash</command:noun> <maml:description> <maml:para>Generate a hash for a document.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Get-PWFileHash</maml:name> <!-- Parameter: InputDocuments --> <command:parameter required="true" 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: Algorithm --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Algorithm</maml:name> <maml:description> <maml:para>Algorithm to use. Default is SHA256.</maml: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>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: Algorithm --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Algorithm</maml:name> <maml:description> <maml:para>Algorithm to use. Default is SHA256.</maml: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>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> <dev:code>Get-PWDocumentsBySearch -FolderPath 'My Folder\Path' -FileName File1.pdf | Get-PWFileHash -Algorithm MD5 $docs = Get-PWDocumentsBySearch -FolderPath 'My Folder\Path' Get-PWFileHash $docs -Algorithm SHA512 | Format-List</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Disable-PWFileStreaming --> <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>Disable-PWFileStreaming</command:name> <command:verb>Disable</command:verb> <command:noun>PWFileStreaming</command:noun> <maml:description> <maml:para>Disables file streaming for the current datasource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Disables file streaming for the current datasource. Can specify which type to disable (PointCloud, Raster, or All).</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Disable-PWFileStreaming</maml:name> <!-- Parameter: FileStreamingType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FileStreamingType</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: FileStreamingType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FileStreamingType</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> <dev:code>The following will disable file streaming for Point Cloud. Disable-PWFileStreaming -FileStreamingType PointCloud -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>The following will disable file streaming for both PointCloud and Raster. Disable-PWFileStreaming -FileStreamingType All -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Enable-PWFileStreaming --> <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>Enable-PWFileStreaming</command:name> <command:verb>Enable</command:verb> <command:noun>PWFileStreaming</command:noun> <maml:description> <maml:para>Enables file streaming for the current datasource. *** Enabling File Streaming will affect Licensing! ***</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Enables file streaming for the current datasource. Can specify which type to enable (PointCloud, Raster, or All). *** Enabling File Streaming will affect Licensing! ***</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Enable-PWFileStreaming</maml:name> <!-- Parameter: FileStreamingType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FileStreamingType</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: FileStreamingType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FileStreamingType</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> <dev:code>The following will enable file streaming for Point Cloud. Enable-PWFileStreaming -FileStreamingType PointCloud -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>The following will enable file streaming for both PointCloud and Raster. Enable-PWFileStreaming -FileStreamingType All -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWFileStreamingMinimumFileSize --> <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-PWFileStreamingMinimumFileSize</command:name> <command:verb>Set</command:verb> <command:noun>PWFileStreamingMinimumFileSize</command:noun> <maml:description> <maml:para>Sets the minimum file size for file streaming within the current datasource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets the minimum file size for file streaming within the current datasource. Can specify which type to update (PointCloud, Raster, or All).</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWFileStreamingMinimumFileSize</maml:name> <!-- Parameter: FileStreamingType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FileStreamingType</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MinimumSize --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MinimumSize</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: FileStreamingType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FileStreamingType</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MinimumSize --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MinimumSize</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:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>The following will set the minimum file size to 25 for Point Cloud file streaming. Set-PWFileStreamingMinimumFileSize -FileStreamingType PointCloud -MinimumSize 25 -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>The following will set the minimum file size to 50 for both PointCloud and Raster. Set-PWFileStreamingMinimumFileSize -FileStreamingType All -MinimumSize 50 -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFileStreamingSettings --> <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-PWFileStreamingSettings</command:name> <command:verb>Get</command:verb> <command:noun>PWFileStreamingSettings</command:noun> <maml:description> <maml:para>Gets the file streaming settings for the current datasource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the file streaming settings for the current datasource. Can specify which type to return (Point Cloud, Raster, or All).</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWFileStreamingSettings</maml:name> <!-- Parameter: FileStreamingType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FileStreamingType</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: FileStreamingType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FileStreamingType</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> <dev:code>The following will return all file streaming settings. Get-PWFileStreamingSettings -FileStreamingType 'All' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>The following will return file streaming settings for file streaming (MIME) Type 'Point Cloud' ONLY. Get-PWFileStreamingSettings -FileStreamingType 'PointCloud' -Verbose</dev:code> </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> <dev:code>Example usage for adding a file type association to the File Property document processor. Add-PWFileTypeAssocation -Type "File Property" -DoNotProcessFiles -Verbose </dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWFlatSetMemberVersionLock --> <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-PWFlatSetMemberVersionLock</command:name> <command:verb>Set</command:verb> <command:noun>PWFlatSetMemberVersionLock</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWFlatSetMemberVersionLock</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: VersionLock --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VersionLock</maml:name> <maml:description> <maml:para>When the VersionLock switch parameter is included, the member document version will be persistent. Otherwise, will always use the latest version.</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: 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: VersionLock --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VersionLock</maml:name> <maml:description> <maml:para>When the VersionLock switch parameter is included, the member document version will be persistent. Otherwise, will always use the latest version.</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> <dev:code>#Example usage Set-PWFlatSetMemberVersionLock. The following will toggle ON the Version Lock option for the provided flat set member. $Splat_FlatSet = @{ FolderPath = 'Projects\FlatSets' SetName = 'MyNewFlatSet' SetMemberPath = 'Project Documents SetMemberName = '2D-M-SAB-LNWK.dwg' } Set-PWFlatSetMemberVersionLock @SetFileInfo -VersionLock -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>The following will toggle OFF the Version Lock option for the provided flat set member. $Splat_FlatSet = @{ FolderPath = 'Projects\FlatSets' SetName = 'MyNewFlatSet' SetMemberPath = 'Project Documents SetMemberName = '2D-M-SAB-LNWK.dwg' } Set-PWFlatSetMemberVersionLock @SetFileInfo -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFlatSetsBySearch --> <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-PWFlatSetsBySearch</command:name> <command:verb>Get</command:verb> <command:noun>PWFlatSetsBySearch</command:noun> <maml:description> <maml:para>Get an array of flat set document objects based the search criteria.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get an array of flat set document objects based the search criteria.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWFlatSetsBySearch</maml:name> <!-- 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: Attributes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <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: ReturnDataTable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>ReturnDataTable</maml:name> <maml:description> <maml:para>Return DataTable object rather than array of Document objects.</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: PopulatePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="15"> <maml:name>PopulatePath</maml:name> <maml:description> <maml:para>Populate path on return objects/table. Will degrade performance, but not as much as -GetAttributes or -Slow.</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 path to search.</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: JustThisFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <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="6"> <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="7"> <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: Environment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- 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: FolderID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FolderID</maml:name> <maml:description> <maml:para>Folder path to search.</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: JustThisFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <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="6"> <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="7"> <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: Environment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <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="10"> <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: ReturnDataTable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>ReturnDataTable</maml:name> <maml:description> <maml:para>Return DataTable object rather than array of Document objects.</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: PopulatePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="15"> <maml:name>PopulatePath</maml:name> <maml:description> <maml:para>Populate path on return objects/table. Will degrade performance, but not as much as -GetAttributes or -Slow.</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> <dev:code>#Get the flat sets in just this folder $sets = Get-PWFlatSetsBySearch -FolderPath "Test 6\Projects 2" -JustThisFolder #Get the flat sets in this folder tree matching these attributes Get-PWFlatSetsBySearch -FolderPath "Test 6\Projects 2" -Attributes @{Name = 'Value'; Name2 = 'Value2' }</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>Copy-PWFolder copies a folder to the root directory or a specified target folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Copy an existing folder into the root directory or another folder. Can include subfolders and/or documents, as well as document attributes, access control, workflow and workspace settings.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: FolderPath --> <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="2"> <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, the workflow setting will not be copied. By default, it will.</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> <!-- Parameter: IncludeWorkspaceProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeWorkspaceProfile</maml:name> <maml:description> <maml:para>If included, the workspace profile 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: SkipFolderWorkflowSecurityReplication --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipFolderWorkflowSecurityReplication</maml:name> <maml:description> <maml:para>Skip the Folder + Workflow security replication which can be quite time consuming. Workflow security whould probably be set globally anyway...</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: TargetPrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetPrefix</maml:name> <maml:description> <maml:para>If TargetPrefix is set, will process user lists with that prefix into ones with the template prefix ([TEMPLATE]_ProjectManagers => TargetPrefix_ProjectManagers)</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TemplatePrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TemplatePrefix</maml:name> <maml:description> <maml:para>Defaults to '[TEMPLATE]'. If TargetPrefix is set, will process user lists with that prefix into ones with the tempalte prefix ([TEMPLATE]_ProjectManagers => TargetPrefix_ProjectManagers)</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> </command:syntaxItem> <!-- Parameter set: Root --> <command:syntaxItem> <maml:name>Copy-PWFolder</maml:name> <!-- Parameter: CreateAtRoot --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>CreateAtRoot</maml:name> <maml:description> <maml:para>When included, the folder will be copied into the root 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> <!-- Parameter: FolderToCopy --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <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, the workflow setting will not be copied. By default, it will.</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> <!-- Parameter: IncludeWorkspaceProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeWorkspaceProfile</maml:name> <maml:description> <maml:para>If included, the workspace profile 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: SkipFolderWorkflowSecurityReplication --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipFolderWorkflowSecurityReplication</maml:name> <maml:description> <maml:para>Skip the Folder + Workflow security replication which can be quite time consuming. Workflow security whould probably be set globally anyway...</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: TargetPrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetPrefix</maml:name> <maml:description> <maml:para>If TargetPrefix is set, will process user lists with that prefix into ones with the template prefix ([TEMPLATE]_ProjectManagers => TargetPrefix_ProjectManagers)</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TemplatePrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TemplatePrefix</maml:name> <maml:description> <maml:para>Defaults to '[TEMPLATE]'. If TargetPrefix is set, will process user lists with that prefix into ones with the tempalte prefix ([TEMPLATE]_ProjectManagers => TargetPrefix_ProjectManagers)</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> </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: CreateAtRoot --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>CreateAtRoot</maml:name> <maml:description> <maml:para>When included, the folder will be copied into the root 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> <!-- Parameter: FolderToCopy --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <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, the workflow setting will not be copied. By default, it will.</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> <!-- Parameter: IncludeWorkspaceProfile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeWorkspaceProfile</maml:name> <maml:description> <maml:para>If included, the workspace profile 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: TemplatePrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TemplatePrefix</maml:name> <maml:description> <maml:para>Defaults to '[TEMPLATE]'. If TargetPrefix is set, will process user lists with that prefix into ones with the tempalte prefix ([TEMPLATE]_ProjectManagers => TargetPrefix_ProjectManagers)</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: TargetPrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetPrefix</maml:name> <maml:description> <maml:para>If TargetPrefix is set, will process user lists with that prefix into ones with the template prefix ([TEMPLATE]_ProjectManagers => TargetPrefix_ProjectManagers)</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SkipFolderWorkflowSecurityReplication --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipFolderWorkflowSecurityReplication</maml:name> <maml:description> <maml:para>Skip the Folder + Workflow security replication which can be quite time consuming. Workflow security whould probably be set globally anyway...</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> <dev:code>Example usage for Copying a folder. This copies the dwgs folder into the projects folder. No documents or sub-folders are included. Copy-PWFolder -FolderPath "Projects" -FolderToCopy 'DWGS'</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>This copies the DWGS folder into the Project01 folder. Sub-folders and documents will be copied. Copy-PWFolder -FolderPath "Project Folder\Project 01" -FolderToCopy 'Working Folder\DWGS' -IncludeSubFolders -IncludeDocuments</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>This copies the DWGS folder into the Project01 folder. Sub-folders and documents will be copied. Document attribute values will also be copied. Copy-PWFolder -FolderPath "Project Folder\Project 01" -FolderToCopy 'Working Folder\DWGS' -IncludeSubFolders -IncludeDocuments -IncludeDocumentAttributes</dev:code> </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: InputFolder --> <command:syntaxItem> <maml:name>Move-PWFolder</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Input folder object (from the pipeline) to move.</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: NewParentPath_Or_ROOT_ --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewParentPath_Or_ROOT_</maml:name> <maml:description> <maml:para>Target folder or root directory to move folder into. Use _ROOT_ to move to the root directory.</maml: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: FolderPath --> <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> <maml:description> <maml:para>Full path to the folder to be moved.</maml:para> </maml:description> <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> <maml:description> <maml:para>Target folder or root directory to move folder into. Use _ROOT_ to move to the root directory.</maml: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>Input folder object (from the pipeline) to move.</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="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Full path to the folder to be moved.</maml:para> </maml:description> <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> <maml:description> <maml:para>Target folder or root directory to move folder into. Use _ROOT_ to move to the root directory.</maml: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>Input folder object (from the pipeline) to move.</maml:para> </maml:description> </command:inputType> </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="false" 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> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description 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="false" 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> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description 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> <dev:code>#Example usage getting folders and populating path. #Create the path in storage area Storage01 New-PWFolder -FolderPath 'New Folder\From PowerShell\Folder 1' -StorageArea Storage01 #Create the path in storage area 'Storage01' with environment 'Default' and workflow 'Normal' New-PWFolder -FolderPath 'Level 1\Level 2\Level 3\Level 4' -StorageArea Storage01 -Environment Default -Workflow Normal</dev:code> </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> <maml:description> <maml:para>Remove folders in a tree given folder path, folder id or array from pipeline. -RemoveFolders switch will just delete the empty leaf folders. -RemoveDocuments will just remove the documents in the given tree. Combine -RemoveFolders -RemoveDocuments to completely remove the tree.</maml:para> <maml:para>-ProceedWithDelete is a required parameter.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Remove-PWFolder</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: RemoveDocuments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RemoveDocuments</maml:name> <maml:description> <maml:para>Set to remove 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: RemoveFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>RemoveFolders</maml:name> <maml:description> <maml:para>Set to remove 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: ProceedWithDelete --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>ProceedWithDelete</maml:name> <maml:description> <maml:para>Required to proceed.</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: DeletePasses --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DeletePasses</maml:name> <maml:description> <maml:para>Defaults to 10. Less is probably fine. More probably not 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>10</dev:defaultValue> </command:parameter> <!-- Parameter: AlternateFolderRemovalProcess --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>AlternateFolderRemovalProcess</maml:name> <maml:description> <maml:para>Do not 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: FullPathToFileRemovalScript --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>FullPathToFileRemovalScript</maml:name> <maml:description> <maml:para>Do not use.</maml: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: FolderID --> <command:syntaxItem> <maml:name>Remove-PWFolder</maml:name> <!-- Parameter: FolderID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderID</maml:name> <maml:description> <maml:para>Folder ID for folder to be removed.</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: RemoveDocuments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RemoveDocuments</maml:name> <maml:description> <maml:para>Set to remove 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: RemoveFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>RemoveFolders</maml:name> <maml:description> <maml:para>Set to remove 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: ProceedWithDelete --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>ProceedWithDelete</maml:name> <maml:description> <maml:para>Required to proceed.</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: DeletePasses --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DeletePasses</maml:name> <maml:description> <maml:para>Defaults to 10. Less is probably fine. More probably not 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>10</dev:defaultValue> </command:parameter> <!-- Parameter: AlternateFolderRemovalProcess --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>AlternateFolderRemovalProcess</maml:name> <maml:description> <maml:para>Do not 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: FullPathToFileRemovalScript --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>FullPathToFileRemovalScript</maml:name> <maml:description> <maml:para>Do not use.</maml: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: FolderPath --> <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> <maml:description> <maml:para>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: RemoveDocuments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RemoveDocuments</maml:name> <maml:description> <maml:para>Set to remove 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: RemoveFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>RemoveFolders</maml:name> <maml:description> <maml:para>Set to remove 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: ProceedWithDelete --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>ProceedWithDelete</maml:name> <maml:description> <maml:para>Required to proceed.</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: DeletePasses --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DeletePasses</maml:name> <maml:description> <maml:para>Defaults to 10. Less is probably fine. More probably not 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>10</dev:defaultValue> </command:parameter> <!-- Parameter: AlternateFolderRemovalProcess --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>AlternateFolderRemovalProcess</maml:name> <maml:description> <maml:para>Do not 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: FullPathToFileRemovalScript --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>FullPathToFileRemovalScript</maml:name> <maml:description> <maml:para>Do not use.</maml: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> <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: FolderID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderID</maml:name> <maml:description> <maml:para>Folder ID for folder to be removed.</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="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>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: RemoveDocuments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RemoveDocuments</maml:name> <maml:description> <maml:para>Set to remove 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: RemoveFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>RemoveFolders</maml:name> <maml:description> <maml:para>Set to remove 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: ProceedWithDelete --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>ProceedWithDelete</maml:name> <maml:description> <maml:para>Required to proceed.</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: DeletePasses --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DeletePasses</maml:name> <maml:description> <maml:para>Defaults to 10. Less is probably fine. More probably not 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>10</dev:defaultValue> </command:parameter> <!-- Parameter: AlternateFolderRemovalProcess --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>AlternateFolderRemovalProcess</maml:name> <maml:description> <maml:para>Do not 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: FullPathToFileRemovalScript --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>FullPathToFileRemovalScript</maml:name> <maml:description> <maml:para>Do not use.</maml: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> <dev:code>Get-PWFolders -FolderPath 'Top Level\Sub-Folder' | Remove-PWFolder -RemoveDocuments -RemoveFolders -ProceedWithDelete Remove-PWFolder -FolderPath 'Top Level\Sub-Folder' -RemoveDocuments -RemoveFolders -ProceedWithDelete Remove-PWFolder -FolderPath 'Top Level\Sub-Folder' -RemoveDocuments -RemoveFolders -ProceedWithDelete -DeletePasses 15</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFolderAuditTrailRecords --> <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-PWFolderAuditTrailRecords</command:name> <command:verb>Get</command:verb> <command:noun>PWFolderAuditTrailRecords</command:noun> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWFolderAuditTrailRecords</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. Connected projects will be added to this folders</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: OutputFilePathName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputFilePathName</maml:name> <maml:description> <maml:para>Provide file path and 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: OutputFormat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>If OutputFilePathName is provided, the OutputFormat is required. Specifies export type. Valid entries are Excel and SQLite.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GetMissingActiveDocuments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>GetMissingActiveDocuments</maml:name> <maml:description> <maml:para>Special report on missing active documents. Don't specify IncludeDocuments.</maml:para> <maml:para>Included for legacy script support. Ignored.</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>When the IncludeDocuments switch parameter is included, the document audit trail entries 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> <!-- Parameter: IncludeSecondary --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IncludeSecondary</maml:name> <maml:description> <maml:para>Included for legacy script support. Ignored.</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>When the IncludeSubFolder switch parameter is included, the subfolder audit trail entries 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> <!-- Parameter: SkipSecondary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipSecondary</maml:name> <maml:description> <maml:para>When the SkipSecondary switch parameter is included, only records from dms_audt are 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> <!-- Parameter set: FolderPath --> <command:syntaxItem> <maml:name>Get-PWFolderAuditTrailRecords</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" 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: OutputFilePathName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputFilePathName</maml:name> <maml:description> <maml:para>Provide file path and 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: OutputFormat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>If OutputFilePathName is provided, the OutputFormat is required. Specifies export type. Valid entries are Excel and SQLite.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GetMissingActiveDocuments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>GetMissingActiveDocuments</maml:name> <maml:description> <maml:para>Special report on missing active documents. Don't specify IncludeDocuments.</maml:para> <maml:para>Included for legacy script support. Ignored.</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>When the IncludeDocuments switch parameter is included, the document audit trail entries 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> <!-- Parameter: IncludeSecondary --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IncludeSecondary</maml:name> <maml:description> <maml:para>Included for legacy script support. Ignored.</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>When the IncludeSubFolder switch parameter is included, the subfolder audit trail entries 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> <!-- Parameter: SkipSecondary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipSecondary</maml:name> <maml:description> <maml:para>When the SkipSecondary switch parameter is included, only records from dms_audt are 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: 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. Connected projects will be added to this folders</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="true" globbing="false" pipelineInput="true (ByValue)" 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: IncludeSubFolders --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSubFolders</maml:name> <maml:description> <maml:para>When the IncludeSubFolder switch parameter is included, the subfolder audit trail entries 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> <!-- Parameter: IncludeDocuments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeDocuments</maml:name> <maml:description> <maml:para>When the IncludeDocuments switch parameter is included, the document audit trail entries 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> <!-- Parameter: SkipSecondary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipSecondary</maml:name> <maml:description> <maml:para>When the SkipSecondary switch parameter is included, only records from dms_audt are 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> <!-- Parameter: IncludeSecondary --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IncludeSecondary</maml:name> <maml:description> <maml:para>Included for legacy script support. Ignored.</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: OutputFilePathName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputFilePathName</maml:name> <maml:description> <maml:para>Provide file path and 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: OutputFormat --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>If OutputFilePathName is provided, the OutputFormat is required. Specifies export type. Valid entries are Excel and SQLite.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GetMissingActiveDocuments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>GetMissingActiveDocuments</maml:name> <maml:description> <maml:para>Special report on missing active documents. Don't specify IncludeDocuments.</maml:para> <maml:para>Included for legacy script support. Ignored.</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 ProjectWise folders from pipeline. Connected projects will be added to this folders</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 folder path to folder containing document of retrieve audit trail records of.</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>Included for legacy script support. Ignored.</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>Special report on missing active documents. Don't specify IncludeDocuments.</maml:para> <maml:para>Included for legacy script support. Ignored.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Show-PWFolderBrowserDialog --> <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-PWFolderBrowserDialog</command:name> <command:verb>Show</command:verb> <command:noun>PWFolderBrowserDialog</command:noun> <maml:description> <maml:para>Pick a ProjectWise Folder from a dialog.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InitialFolderPath --> <command:syntaxItem> <maml:name>Show-PWFolderBrowserDialog</maml:name> <!-- Parameter: InitialFolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>InitialFolderPath</maml:name> <maml:description> <maml:para>Initial folder path (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: InitialFolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>InitialFolderPath</maml:name> <maml:description> <maml:para>Initial folder path (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> <!-- OutputType: ProjectWiseFolder --> <command:returnValue> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$folder = Show-PWFolderBrowserDialog "Top level\second level\third level"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFolderByURN --> <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-PWFolderByURN</command:name> <command:verb>Get</command:verb> <command:noun>PWFolderByURN</command:noun> <maml:description> <maml:para>Get folder object from URN address as copied from PW Explorer address bar.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get folder object from URN address as copied from PW Explorer address bar.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: URN --> <command:syntaxItem> <maml:name>Get-PWFolderByURN</maml:name> <!-- Parameter: URN --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>URN</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: URN --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>URN</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> <dev:code>$folder = Get-PWFolderByURN "pw://decide-pwce-us.bentley.com:decide-pwce-us-10/Documents/P{890d88c3-1e68-40bc-98c8-160277d9bca7}/"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFolderDocumentSize --> <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-PWFolderDocumentSize</command:name> <command:verb>Get</command:verb> <command:noun>PWFolderDocumentSize</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, storage, file folder path. .</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWFolderDocumentSize</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="1"> <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> <!-- Parameter: GetAllDocumentsInTree --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>GetAllDocumentsInTree</maml:name> <maml:description> <maml:para>If not provided will only count the documents directly in the input folder. Otherwise, calculates from tree like Get-PWFolderTreeSize</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: OpenSpreadsheet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>OpenSpreadsheet</maml:name> <maml:description> <maml:para>Open spreadsheet on successful creation</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="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> <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> <!-- Parameter: GetAllDocumentsInTree --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>GetAllDocumentsInTree</maml:name> <maml:description> <maml:para>If not provided will only count the documents directly in the input folder. Otherwise, calculates from tree like Get-PWFolderTreeSize</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: OpenSpreadsheet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>OpenSpreadsheet</maml:name> <maml:description> <maml:para>Open spreadsheet on successful creation</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> <dev:code>Get-PWFolders -FolderPath "Top Level Folder\Sub-Folder" | Get-PWFolderDocumentSize"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-PWFolders -FolderPath "Top Level Folder\Sub-Folder" | Get-PWFolderDocumentSize -OutputFileName "D:\TEMP\FolderDocSizeReport.xlsx"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFolderDocumentSizeByPath --> <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-PWFolderDocumentSizeByPath</command:name> <command:verb>Get</command:verb> <command:noun>PWFolderDocumentSizeByPath</command:noun> <maml:description> <maml:para>Returns information pertaining to each folder passed. Includes ProjectID, FolderPath, Number of documents, sum of document sizes, storage, file folder path. Skips empty folders.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: FolderPath --> <command:syntaxItem> <maml:name>Get-PWFolderDocumentSizeByPath</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" 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="false" globbing="false" pipelineInput="false" position="1"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Full path to XLSX output 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: WholeDatasource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>WholeDatasource</maml:name> <maml:description> <maml:para>Flag to 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> <!-- Parameter: OpenSpreadsheet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>OpenSpreadsheet</maml:name> <maml:description> <maml:para>Flag to open spreadsheet.</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="true (ByValue)" 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="false" globbing="false" pipelineInput="false" position="1"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Full path to XLSX output 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: WholeDatasource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>WholeDatasource</maml:name> <maml:description> <maml:para>Flag to 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> <!-- Parameter: OpenSpreadsheet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>OpenSpreadsheet</maml:name> <maml:description> <maml:para>Flag to open spreadsheet.</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> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWFolderDocumentSizeByPath "Projects\Archived Projects" -OutputFileName "D:\TEMP\FolderDocSizeReport.xlsx"</dev:code> </command:example> </command:examples> </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> <dev:code>#Example usage for reading a folder's location in GeoJSON. Get-PWFolder -FolderPath "My Locations\Folder 2" -JustOne| Get-PWFolderGeoSpatialLocation -GetGeoJSON #Example usage for reading a folder's location in KML. Get-PWFolder -FolderPath "My Locations\Folder 2" -JustOne| Get-PWFolderGeoSpatialLocation -GetKML #Example usage for reading a folder's location in WKT. Get-PWFolder -FolderPath "My Locations\Folder 2" -JustOne| Get-PWFolderGeoSpatialLocation</dev:code> </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> <dev:code>#Example usage for creating a new folder and assigning a location to it. New-PWFolder -FolderPath "My Locations\Folder 2" -StorageArea "Storage 1" | Set-PWFolderGeoSpatialLocation -Latitude 45 -Longitude 90 New-PWFolder -FolderPath "My Locations\Folder 3" -StorageArea "Storage 1" | Set-PWFolderGeoSpatialLocation -Address "704 15th Street, Durham, NC" -Point </dev:code> </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: FolderID --> <command:syntaxItem> <maml:name>Update-PWFolderNameProps</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" 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: FolderID --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>FolderID</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: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <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="true (ByValue)" position="3"> <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="false" globbing="false" pipelineInput="true (ByValue)" 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: FolderID --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>FolderID</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: NewName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <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="true (ByValue)" position="3"> <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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</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: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> <dev:code>#Example usage for Update-PWFolderNameProps. #Will rename the folder passed in the FolderPath parameter. Update-PWFolderNameProps -FolderPath 'Projects' -NewName 'NewProjects'</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Example usage for Update-PWFolderNameProps. #Will update the description of the folder passed in the FolderPath parameter. Update-PWFolderNameProps -FolderPath 'Projects' -NewDescription 'New Projects'</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>#Example usage for Update-PWFolderNameProps. #Will rename and update the description of the folder passed in the FolderPath parameter. Update-PWFolderNameProps -FolderPath 'Projects' -NewName 'NewProjects' -NewDescription 'New Projects'</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>#Example usage for Update-PWFolderNameProps. $folders=Get-PWFolders -FolderPath 'Top Level\Sub-Folder' foreach ($folder in $folders) {Update-PWFolderNameProps $folder.ProjectID -NewName 'X' -NewDescription 'Y'}</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWFolderOwner --> <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-PWFolderOwner</command:name> <command:verb>Set</command:verb> <command:noun>PWFolderOwner</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWFolderOwner</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 the owner is a user, group, or userlist.</maml:para> <maml:para>Valid entries are</maml:para> <maml:para>For users: "User"</maml:para> <maml:para>For groups: "Group"</maml:para> <maml:para>For userlists: "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="false" 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> </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 the owner is a user, group, or userlist.</maml:para> <maml:para>Valid entries are</maml:para> <maml:para>For users: "User"</maml:para> <maml:para>For groups: "Group"</maml:para> <maml:para>For userlists: "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="false" 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> </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: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> <dev:code>#Example usage getting folders and populating path. #Get the path and all properties for folder number 20315 Get-PWFolders 20315 | Get-PWFolderPathAndProperties #Get the folder number and all properties for the given folder path Get-PWFolders -FolderPath 'Level 1\Level 2\Level 3\Level 4' -JustOne | Get-PWFolderPathAndProperties</dev:code> </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: InputFolder --> <command:syntaxItem> <maml:name>Get-PWFolderRenditionProfile</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. Rendition profile will be applied to each folder.</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> <!-- Parameter set: FolderPath --> <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: 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. Rendition profile will be applied to each folder.</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="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: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. Rendition profile will be applied to each folder.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for getting a default rendition profile. Get-PWFolderRenditionProfile -FolderPath 'Projects\My Project'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-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>Remove-PWFolderRenditionProfile</command:name> <command:verb>Remove</command:verb> <command:noun>PWFolderRenditionProfile</command:noun> <maml:description> <maml:para>Removes the default rendition profile set for the specified folder.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Remove-PWFolderRenditionProfile</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. Rendition profile will be removed for each folder.</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> <!-- Parameter set: FolderPath --> <command:syntaxItem> <maml:name>Remove-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 remove the default rendition profile 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> </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. Rendition profile will be removed for each folder.</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="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path to remove the default rendition profile 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> </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. Rendition profile will be removed for each folder.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for removing the default rendition profile. Remove-PWFolderRenditionProfile -FolderPath 'Projects\My Project'</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Example usage for removing the default rendition profile via pipeline. Get-PWFolders -FolderPath 'BSI900 - Adelaide Tower' -Slow -Justone | 'Remove-PWFolderRenditionProfile -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>#Example usage for removing the default rendition profile using InputFolders. $folders = Get-PWFolders -FolderPath 'BSI900 - Adelaide Tower' -Slow Remove-PWFolderRenditionProfile -InputFolders $folders -Verbose</dev:code> </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: InputFolder --> <command:syntaxItem> <maml:name>Set-PWFolderRenditionProfile</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. Rendition profile will be applied to each folder.</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: 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> <!-- Parameter set: FolderPath --> <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: 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. Rendition profile will be applied to each folder.</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="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: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. Rendition profile will be applied to each folder.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for setting a default rendition profile. Set-PWFolderRenditionProfile -FolderPath "Projects\My Project" -ProfileName "PDF to Source Folder" -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Example usage for setting a default rendition profile via pipeline. Get-PWFolders -FolderPath 'BSI900 - Adelaide Tower' -Slow -Justone | 'Set-PWFolderRenditionProfile -ProfileName "PDF to Source Folder" -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>#Example usage for setting a default rendition profile using InputFolders. $folders = Get-PWFolders -FolderPath 'BSI900 - Adelaide Tower' -Slow Set-PWFolderRenditionProfile -InputFolders $folders -ProfileName "PDF to Source Folder" -Verbose</dev:code> </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>OBSOLETE. Not used.</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> <!-- Parameter: PopulatePaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>PopulatePaths</maml:name> <maml:description> <maml:para>Populate paths. Should be more performant than -Slow though somewhat less data is returned.</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>OBSOLETE. Not used.</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> <!-- Parameter: PopulatePaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>PopulatePaths</maml:name> <maml:description> <maml:para>Populate paths. Should be more performant than -Slow though somewhat less data is returned.</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> <dev:code>#Example usage for getting all the folders in a given folder path. #Get all the folders in this tree $folders = Get-PWFolders -FolderPath "PWPS Connected Project Test 6\Projects 2" #Get all the folders in this tree with paths populated $folders = Get-PWFolders -FolderPath "PWPS Connected Project Test 6\Projects 2" -PopulatePaths #Get all the folders in this tree with paths and all data populated $folders = Get-PWFolders -FolderPath "PWPS Connected Project Test 6\Projects 2" -Slow</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Copy-PWFoldersBetweenDatasources --> <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-PWFoldersBetweenDatasources</command:name> <command:verb>Copy</command:verb> <command:noun>PWFoldersBetweenDatasources</command:noun> <maml:description> <maml:para>Copies a folder tree from one datasource to another datasource. Optionally copy documents, too.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes a folder object and copies the tree structue to a target parent folder in another datasource. Optionally, copies documents.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolders --> <command:syntaxItem> <maml:name>Copy-PWFoldersBetweenDatasources</maml:name> <!-- Parameter: InputFolders --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolders</maml:name> <maml:description> <maml:para>Source folder object (Required).</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: TargetDatasource --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetDatasource</maml:name> <maml:description> <maml:para>Target datasource 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: TargetParentPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>TargetParentPath</maml:name> <maml:description> <maml:para>Path to target parent 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: TargetStorage --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>TargetStorage</maml:name> <maml:description> <maml:para>Target 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: IgnoreMissingEnvironments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>IgnoreMissingEnvironments</maml:name> <maml:description> <maml:para>Ignore missing environments in target. Otherwise, copy will not proceed unless environment 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> <!-- Parameter: IgnoreMissingWorkflows --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>IgnoreMissingWorkflows</maml:name> <maml:description> <maml:para>Ignore missing workflows in target. Otherwise, copy will not proceed unless workflow 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> <!-- Parameter: IgnoreMissingProjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>IgnoreMissingProjectTypes</maml:name> <maml:description> <maml:para>Ignore missing project types in target. Otherwise, copy will not proceed unless project type 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> <!-- Parameter: IgnoreMissingViews --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>IgnoreMissingViews</maml:name> <maml:description> <maml:para>Ignore missing views in target. Otherwise, copy will not proceed unless views are 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> <!-- Parameter: IncludeDocuments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>IncludeDocuments</maml:name> <maml:description> <maml:para>Include documents. Will copy ownership, create, update and file update dates, state and workflow (if applicable). Preserves reference relationships if master and reference included in same 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> <!-- Parameter: IncludeAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>IncludeAuditTrail</maml:name> <maml:description> <maml:para>Include 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> </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>Source folder object (Required).</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: TargetDatasource --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetDatasource</maml:name> <maml:description> <maml:para>Target datasource 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: TargetParentPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>TargetParentPath</maml:name> <maml:description> <maml:para>Path to target parent 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: TargetStorage --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>TargetStorage</maml:name> <maml:description> <maml:para>Target 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: IgnoreMissingEnvironments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>IgnoreMissingEnvironments</maml:name> <maml:description> <maml:para>Ignore missing environments in target. Otherwise, copy will not proceed unless environment 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> <!-- Parameter: IgnoreMissingWorkflows --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>IgnoreMissingWorkflows</maml:name> <maml:description> <maml:para>Ignore missing workflows in target. Otherwise, copy will not proceed unless workflow 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> <!-- Parameter: IgnoreMissingProjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>IgnoreMissingProjectTypes</maml:name> <maml:description> <maml:para>Ignore missing project types in target. Otherwise, copy will not proceed unless project type 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> <!-- Parameter: IgnoreMissingViews --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>IgnoreMissingViews</maml:name> <maml:description> <maml:para>Ignore missing views in target. Otherwise, copy will not proceed unless views are 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> <!-- Parameter: IncludeDocuments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>IncludeDocuments</maml:name> <maml:description> <maml:para>Include documents. Will copy ownership, create, update and file update dates, state and workflow (if applicable). Preserves reference relationships if master and reference included in same 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> <!-- Parameter: IncludeAuditTrail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>IncludeAuditTrail</maml:name> <maml:description> <maml:para>Include 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Source folder object (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Get top level folder and copy tree to a target folder in another datasource $folder = Show-PWFolderBrowserDialog Copy-PWFoldersBetweenDatasources $folder -TargetDatasource brumd09515rem:importtest2 -TargetParentPath 'Copy Folders\Here' -TargetStorage Storage01</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>New-PWLogin naou22468a:SQL2017 -UserName pwadmin -Password (ConvertTo-SecureString pwadmin -AsPlainText -Force) New-PWLogin naou22468a:pwv8i $td = "naou22468a:SQL2017" $su = "pw://naou22468a.bentley.com:pwv8i/Documents/P{f2c1eccb-162e-4bbc-99e8-1e884f97cacb}/" $tf = "Copy Folders Between Datasources\Test 25\References Test" Get-PWFolderByURN $su | Copy-PWFoldersBetweenDatasources -TargetDatasource $td -TargetParentPath $tf -TargetStorage Storage -IgnoreMissingEnvironments -IgnoreMissingWorkflows -IgnoreMissingViews -IgnoreMissingProjectTypes -IncludeDocuments</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFoldersByAccessMember --> <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-PWFoldersByAccessMember</command:name> <command:verb>Get</command:verb> <command:noun>PWFoldersByAccessMember</command:noun> <maml:description> <maml:para>Get-PWFoldersByAccessMember is used to get a list of folder objects which has a member explicitly set in its access control.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns an array of ProjectWise Folder objects which the membername explicitly set in its access control. If no ProjectWise folders are passed to the InputFolder parameter, the user will be prompted to complete the process unless the -SearchEntireDatasource switch parameter is included.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWFoldersByAccessMember</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: 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> <!-- Parameter set: EntireDatasource --> <command:syntaxItem> <maml:name>Get-PWFoldersByAccessMember</maml:name> <!-- 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> <!-- Parameter: SearchEntireDatasource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SearchEntireDatasource</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: 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> <!-- Parameter: SearchEntireDatasource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SearchEntireDatasource</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> <dev:code>#Example usage getting projects / folders with specified member in its access control. The following example will return an array of ProjectWise Folder objects from the folders being passed via the pipeline, which have the 'Read_Only' userlist applied to its access control. $pwFolders = Get-PWFolders -FolderPath 'Projects' | Get-PWFoldersByAccessMember -MemberType 'UserList' -MemberName 'Read_Only' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Example usage getting projects / folders with specified member in its access control. The following example will return an array of ProjectWise Folder objects from the folders being passed, which have the 'Read_Only' userlist applied to its access control. $pwFolders = Get-PWFolders -FolderPath 'Projects' Get-PWFoldersByAccessMember -InputFolder $pwFolders -MemberType 'UserList' -MemberName 'Read_Only' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>#Example usage getting projects / folders with specified member in its access control. The following example will return an array of ProjectWise Folder objects from the ENTIRE datasource, which have the 'PowerShell Users' group applied to its access control. The user will be prompted to complete the process. Get-PWFoldersByAccessMember -MemberType 'Group' -MemberName 'PowerShell Users' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>#Example usage getting projects / folders with specified member in its access control. The following example will return an array of ProjectWise Folder objects from the ENTIRE datasource, which have the 'PowerShell Users' group applied to its access control. Get-PWFoldersByAccessMember -MemberType 'Group' -MemberName 'PowerShell Users' -SearchEntireDatasource -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFoldersByGUIDs --> <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-PWFoldersByGUIDs</command:name> <command:verb>Get</command:verb> <command:noun>PWFoldersByGUIDs</command:noun> <maml:description> <maml:para>Returns an array of folder object(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns an array folder object(s) with the provided GUIDs.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Array of Folder GUIDs. --> <command:syntaxItem> <maml:name>Get-PWFoldersByGUIDs</maml:name> <!-- Parameter: FolderGUIDs --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderGUIDs</maml:name> <maml:description> <maml:para>Array of Folder GUIDs.</maml: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: FolderGUIDs --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderGUIDs</maml:name> <maml:description> <maml:para>Array of Folder GUIDs.</maml: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> <dev:code>Returns the folder object with the specified GUID. Get-PWFoldersByGUIDs -FolderGUIDs 'd0bc426a-973e-4ebe-8764-7739e81e9182' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Returns the folder object(s) with the specified GUIDs. Get-PWFoldersByGUIDs -FolderGUIDs 'd0bc426a-973e-4ebe-8764-7739e81e9182', '31050aa0-bf0c-4804-a9f4-236c54496f33' -Verbose</dev:code> </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> <maml:description> <maml:para>The Get-PWFolderSecurity cmdlet is used to get access control information for a specific project/folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-PWFolderSecurity cmdlet is used to get access control information for a specific project/folder. This cmdlet will return a datatable specifying the project/folder access control type, name, security type (document or project/folder), the access control settings (mask value), and if it is inheriting access control, where from. If nothing is listed in the Inherited_From column, that indicates the access settings are applied directly to the project/folder. ProjectName | Type | Name | SecurityType | Access_Control_Settings | Workflow | State |Inheriting_From | FullPath ------------|-----------|-----------------|-----------------|---------------------------|--------------|-------------|-------------------|---------------------- DWGs | user | admin | Project/Folder | 65535 | | | Projects | Projects\DWGs DWGs | group | administrators | Project/Folder | 65535 | | | Projects | Projects\DWGs DWGs | userlist | all_users | Project/Folder | 6 | | | Projects | Projects\DWGs DWGs | user | admin | Document | 65535 | Workflow 1 | Initiated | | Projects\DWGS DWGs | userlist | all_users | Document | 190 | | | | Projects\DWGs</maml:para> </maml:description> <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> <dev:code>#Example usage getting project/folder access control. The following will return a datatable containing the access control of the specified project/folder. Get-PWFolders -FolderPath 'projects' -JustOne -Slow | Get-PWFolderSecurity</dev:code> </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: __AllParameterSets --> <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="false" 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> <!-- 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: StateName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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: WorkflowName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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: 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="false" 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> <!-- 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: WorkflowName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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="false" globbing="false" pipelineInput="false" position="named"> <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:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </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: AllSecurity --> <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="true" 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: IncludeWorkflows --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeWorkflows</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> <!-- Parameter set: Security --> <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: 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: IncludeWorkflows --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeWorkflows</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="true" 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> <!-- Parameter: IncludeWorkflows --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeWorkflows</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: 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>For Everyone: "Everyone"</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: Access --> <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="false" 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: 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> <!-- Parameter set: AccessString --> <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="false" 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: MemberAccessString --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>MemberAccessString</maml:name> <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> <!-- Parameter set: Roles --> <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="false" 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: 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: 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="false" 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: MemberAccessString --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>MemberAccessString</maml:name> <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> <dev:code>The following example will update the security for the folders being passed via the pipeline, project/folder security only. The user will be added with create, read, write, and delete permissions. PS C:\>Get-PWFolders -FolderPath 'Projects' -Slow | Update‐PWFolderSecurity ‐MemberType ʺuʺ ‐MemberName “username” ‐MemberAccess “c”, “r”, “w”, “d” ‐FolderSecurity -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>The following example will update the security for the one folder, both project/folder and document security. The group, New Group, will be added with read, write for project/folder and read, write, file read, and file write permissions. PS C:\>Get-PWFolders -FolderPath 'Projects' -JustOne -Slow | Update‐PWFolderSecurity ‐MemberType ʺgʺ ‐MemberName “New Group” ‐MemberAccess “r”, “w”, “fr”, “fw” ‐FolderSecurity ‐DocumentSecurity -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>The following example will update the security for the folders being passed via the pipeline, document security only. The userlist, All_Users will be added with read, file read permissions. PS C:\>Get-PWFolders -FolderPath 'Projects' -Slow | Update‐PWFolderSecurity ‐MemberType ʺulʺ ‐MemberName “All_Users” ‐MemberAccess “r”, “fr” ‐DocumentSecurity -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>The following example will update the security for the folders passed via the pipeline, document security only. The userlist, All_Users will be added with read, file read permissions. PS C:\>Get-PWFolders -FolderPath 'Projects' -Slow | Update‐PWFolderSecurity ‐MemberType ʺulʺ ‐MemberName “All_Users” ‐Role “Project Observer” -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>The following example will update the security for the specified folder to include the inherited access control. Both folder and document security will be updated. The userlist, All_Users will be added with read, file read permissions. PS C:\>Get-PWFolders -FolderPath 'Projects' -JustOne -Slow | Update‐PWFolderSecurity ‐MemberType ʺulʺ ‐MemberName “All_Users” ‐Role “Project Observer” -IncludeInheritance -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>The following example will update the security for the specified folder to include the inherited access control. Both folder and document security will be updated. The 'Everyone' user will be added with the role of Project Observer. PS C:\>Get-PWFolders -FolderPath 'Projects' -JustOne -Slow | Update‐PWFolderSecurity ‐MemberType ʺEveryoneʺ ‐Role “Project Observer” -IncludeInheritance -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 7 ----------</maml:title> <dev:code>The following example will update the security for the specified folder to include the specified access control. Both folder and document security will be updated. The 'psUserList1' userlsit will be added with the --CDrw-RWf- access control. PS C:\>Get-PWFolders -FolderPath 'Projects' -JustOne -Slow | Update‐PWFolderSecurity ‐MemberType 'UserList' -MemberAccessString '--CDrw-RWf-' -FolderSecurity -DocumentSecurity -IncludeInheritance -Verbose</dev:code> </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> <maml:description> <maml:para>Update-PWFolderSecurityByUserListSwap is used to replace a userlist with another userlist within the access control to the specified folders</maml:para> </maml:description> </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:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage updating project/folder access control. The following example will update the security for the folders being passed via the pipeline, project/folder security only. The user will be added with create, read, write, and delete permissions. Get-PWFolders -FolderPath 'Projects' -Slow | Update‐PWFolderSecurityByUserListSwap -NewUserListName "NewUserList" -OldUserListName "OldUserList" -Verbose </dev:code> </command:example> </command:examples> </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>UpdatePWFolderSecurityByUserListSwapWithWorkflow is used to replace existing userlists with another.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>UpdatePWFolderSecurityByUserListSwapWithWorkflow is used to replace existing userlists with another for a project. This includes the folder, document and workflow security.</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> <dev:code>#Example usage updating project/folder access control. The following example will replace the "[TEMPLATE]_UserList" with the "CADD_Users" userlist for just the folder(s) passed via the pipeline. Get-PWFolders -FolderPath 'Projects' | Update-PWFolderSecurityByUserListSwapWithWorkflow ‐NewUserListName ʺCADD_Usersʺ -OldUserListName "[TEMPLATE]_UserList" -JustOne </dev:code> </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> <dev:code>#Example usage for creating folders from an Excel spreadsheet. New-PWFoldersFromSpreadsheet -InputFileName 'd:\temp\import\newprojects.xlsx' -DefaultStorageArea 'Storage'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFoldersImmediateChildren --> <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-PWFoldersImmediateChildren</command:name> <command:verb>Get</command:verb> <command:noun>PWFoldersImmediateChildren</command:noun> <maml:description> <maml:para>Returns an array containing immediate child folder object(s) from the specified parent folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns an array containing immediate child folder object(s) from the specified parent folder.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: FolderID --> <command:syntaxItem> <maml:name>Get-PWFoldersImmediateChildren</maml:name> <!-- Parameter: FolderID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderID</maml:name> <maml:description> <maml:para>Folder ID for parent folder.</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: OutputFilePathName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputFilePathName</maml:name> <maml:description> <maml:para>Path and Name of output file to export report 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: FolderPath --> <command:syntaxItem> <maml:name>Get-PWFoldersImmediateChildren</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path for parent 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: OutputFilePathName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputFilePathName</maml:name> <maml:description> <maml:para>Path and Name of output file to export report 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: Root --> <command:syntaxItem> <maml:name>Get-PWFoldersImmediateChildren</maml:name> <!-- Parameter: OutputFilePathName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputFilePathName</maml:name> <maml:description> <maml:para>Path and Name of output file to export report 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: Root --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Root</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: FolderID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderID</maml:name> <maml:description> <maml:para>Folder ID for parent folder.</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="true" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path for parent 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: Root --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Root</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: OutputFilePathName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputFilePathName</maml:name> <maml:description> <maml:para>Path and Name of output file to export report 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> <dev:code>Returns the immediate child folder object(s) for the project with FolderID of the project selected. Get-PWFoldersImmediateChildren -FolderID (Show-PWFolderBrowserDialog).ProjectID -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Returns all file folders within the ROOT. Get-PWFoldersImmediateChildren -Root -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Returns and exports the immediate child folder object(s) of 'MyProject'. Get-PWFoldersImmediateChildren -FolderPath 'MyProject' -OutputFilePathName 'd:\temp\export.xlsx' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Convert-PWFolderToRichProject --> <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-PWFolderToRichProject</command:name> <command:verb>Convert</command:verb> <command:noun>PWFolderToRichProject</command:noun> <maml:description> <maml:para>Converts a folder to a Rich Project / Work Area.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Converts the specified folder to a Rich Project / Work Area. If a ProjectType is included, it will be applied.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Convert-PWFolderToRichProject</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>ProjectWise folder object to be upgraded to a Rich Project / Work Area.</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: ProjectType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ProjectType</maml:name> <maml:description> <maml:para>Project type used when upgrading to Rich Project / Work Area. Required. 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> </command:syntaxItem> <!-- Parameter set: FolderPath --> <command:syntaxItem> <maml:name>Convert-PWFolderToRichProject</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 folder to be upgraded to a Rich Project / Work 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: ProjectType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ProjectType</maml:name> <maml:description> <maml:para>Project type used when upgrading to Rich Project / Work Area. Required. 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> </command:syntaxItem> <!-- Parameter set: FolderID --> <command:syntaxItem> <maml:name>Convert-PWFolderToRichProject</maml:name> <!-- Parameter: FolderID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderID</maml:name> <maml:description> <maml:para>Folder ID to folder to be upgraded to a Rich Project / Work Area.</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: ProjectType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ProjectType</maml:name> <maml:description> <maml:para>Project type used when upgrading to Rich Project / Work Area. Required. 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> </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>ProjectWise folder object to be upgraded to a Rich Project / Work Area.</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="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Full folder path of folder to be upgraded to a Rich Project / Work 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: FolderID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderID</maml:name> <maml:description> <maml:para>Folder ID to folder to be upgraded to a Rich Project / Work Area.</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: ProjectType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ProjectType</maml:name> <maml:description> <maml:para>Project type used when upgrading to Rich Project / Work Area. Required. 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>ProjectWise folder object to be upgraded to a Rich Project / Work Area.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Example usage for converting a folder to a Rich Project / Work Area using InputFolder. Convert-PWFolderToRichProject -InputFolder (Show-PWFolderBrowserDialog) -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Example usage for converting a folder to a Rich Project / Work Area using a FolderPath and providing a ProjectType. Convert-PWFolderToRichProject -FolderPath "MyRichProject" -ProjectType 'Building' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Example usage for converting a folder to a Rich Project / Work Area using a FolderID and providing a ProjectType. Convert-PWFolderToRichProject -FolderID 70032 -ProjectType 'Civil' -Verbose</dev:code> </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, and the maximum (latest) file update date.</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> <maml:description> <maml:para>Full path to output XLSX 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: 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> <maml:description> <maml:para>Full path to output XLSX 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>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> <dev:code>Get-PWFolders -FolderPath "Top Level Folder\Sub-Folder" | Get-PWFolderTreeSize"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-PWFolders -FolderPath "Top Level Folder\Sub-Folder" | Get-PWFolderTreeSize -OutputFileName "D:\TEMP\FolderDocSizeReport.xlsx"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFolderTreeDocumentSizeByDepth --> <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-PWFolderTreeDocumentSizeByDepth</command:name> <command:verb>Get</command:verb> <command:noun>PWFolderTreeDocumentSizeByDepth</command:noun> <maml:description> <maml:para>Report number of contained documents, sum of document sizes, and the maximum (latest) file update date for folders by depth (defaults to 1 - all top level folders).</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWFolderTreeDocumentSizeByDepth</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Provide a folder to limit report.</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: FolderDepth --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderDepth</maml:name> <maml:description> <maml:para>Use this to set the folder depth you want to report on (Defaults to 1 which is all top level 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>1</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>Full path to output XLSX 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: InputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Provide a folder to limit report.</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: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Full path to output XLSX 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: FolderDepth --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderDepth</maml:name> <maml:description> <maml:para>Use this to set the folder depth you want to report on (Defaults to 1 which is all top level 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>1</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>Provide a folder to limit report.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWFolderTreeDocumentSizeByDepth -Depth 2"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-PWFolderByURN 'pw://naou22468a.bentley.com:pwv8i/Documents/P{054df6a0-b6c2-42a1-b83f-4cfd3b18c9ce}/' | Get-PWFolderTreeDocumentSizeByDepth -FolderDepth 3 -OutputFileName c:\temp\ReportAtFolderDepth3pwv8iA.xlsx</dev:code> </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> <dev:code>Get-PWFolders -FolderPath "Top Level Folder\Sub-Folder" | Get-PWFolderTreeDocumentStateCount -IncludeVersions -OutputFileName "c:\temp\Output.xlsx"</dev:code> </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> <dev:code>Get-PWFolders -FolderPath "Top Level Folder\Sub-Folder" | Get-PWFolderTreeDocumentStateCount -IncludeVersions -OutputFileName "c:\temp\Output.xlsx"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFolderTreeMaxFileUpdateDate --> <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-PWFolderTreeMaxFileUpdateDate</command:name> <command:verb>Get</command:verb> <command:noun>PWFolderTreeMaxFileUpdateDate</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, and the maximum (latest) file update date.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWFolderTreeMaxFileUpdateDate</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 to check.</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="1"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Output spreadsheet name (include .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> </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 to check.</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="1"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Output spreadsheet name (include .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> </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 check.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWFolders -FolderPath "Top Level Folder\Sub-Folder" -JustOne | Get-PWFolderTreeMaxFileUpdateDate"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-PWFolders -FolderPath "Top Level Folder\Sub-Folder" -JustOne | Get-PWFolderTreeMaxFileUpdateDate -OutputFileName "D:\TEMP\FolderDocSizeReport.xlsx"</dev:code> </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: 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="1"> <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="2"> <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="1"> <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="2"> <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> <dev:code>Get-PWFolders -FolderPath "Top Level Folder\Sub-Folder" | Get-PWFolderTreeScalarDataTable -IncludeVersions -DocumentAttributeName "PercentComplete" -ShowColumns</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Move-PWFolderTreeToNewStorage --> <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-PWFolderTreeToNewStorage</command:name> <command:verb>Move</command:verb> <command:noun>PWFolderTreeToNewStorage</command:noun> </command:details> <command:syntax> <!-- Parameter set: FolderPath --> <command:syntaxItem> <maml:name>Move-PWFolderTreeToNewStorage</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Target 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: TargetStorage --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetStorage</maml:name> <maml:description> <maml:para>Target 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: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Target 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: TargetStorage --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetStorage</maml:name> <maml:description> <maml:para>Target 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:command> <!-- Cmdlet: Clear-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>Clear-PWFolderView</command:name> <command:verb>Clear</command:verb> <command:noun>PWFolderView</command:noun> <maml:description> <maml:para>Used to remove the Global Default View or Global Default PreviewPane View from a folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used to remove the Global Default View or Global Default PreviewPane View from a folder.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Clear-PWFolderView</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>ProjectWise folder(s) to clear the default view or default Preview Pane view from.</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: PreviewPaneView --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreviewPaneView</maml:name> <maml:description> <maml:para>Include to remove the default Preview Pane view from the folder(s).</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: View --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>View</maml:name> <maml:description> <maml:para>Include to remove the default view from the folder(s).</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="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>ProjectWise folder(s) to clear the default view or default Preview Pane view from.</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: View --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>View</maml:name> <maml:description> <maml:para>Include to remove the default view from the folder(s).</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: PreviewPaneView --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreviewPaneView</maml:name> <maml:description> <maml:para>Include to remove the default Preview Pane view from the folder(s).</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>ProjectWise folder(s) to clear the default view or default Preview Pane view from.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Clear-PWFolderView -InputFolder (Get-PWFolders -FolderID 177 -JustOne) -View -PreviewPaneView </dev:code> </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="false" 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> <!-- Parameter: PreviewPaneView --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PreviewPaneView</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Remove --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Remove</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: View --> <command:parameter required="false" 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> <!-- Parameter: PreviewPaneView --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PreviewPaneView</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Remove --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Remove</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: Copy-PWFolderViewsToFolders --> <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-PWFolderViewsToFolders</command:name> <command:verb>Copy</command:verb> <command:noun>PWFolderViewsToFolders</command:noun> <maml:description> <maml:para>Copy document list views and preview pane views from one folder tree to another.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Copy document list views and preview pane views from one folder tree to another.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: SourceFolder --> <command:syntaxItem> <maml:name>Copy-PWFolderViewsToFolders</maml:name> <!-- Parameter: SourceFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>SourceFolder</maml:name> <maml:description> <maml:para>Top level folder representing tree to copy from.</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: TargetFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>TargetFolder</maml:name> <maml:description> <maml:para>Top level folder representing tree to copy 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> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SourceFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>SourceFolder</maml:name> <maml:description> <maml:para>Top level folder representing tree to copy from.</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: TargetFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>TargetFolder</maml:name> <maml:description> <maml:para>Top level folder representing tree to copy 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> </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>Top level folder representing tree to copy from.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Top level folder representing tree to copy to.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$source = Get-PWFolderByURN "pw://naou22468a.bentley.com:pwv8i/Documents/P{ba212bab-0afe-43a4-ac61-19c48a420e03}/" $target = Get-PWFolderByURN "pw://naou22468a.bentley.com:pwv8i/Documents/P{d4e97c88-a22f-40b3-ae96-154999a34b93}/" Copy-PWFolderViewsToFolders $source -TargetFolder $target</dev:code> </command:example> </command:examples> </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: Set-PWFolderWorkspaceProfile --> <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-PWFolderWorkspaceProfile</command:name> <command:verb>Set</command:verb> <command:noun>PWFolderWorkspaceProfile</command:noun> <maml:description> <maml:para>Sets the associated workspace profile for a folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Accepts a folder object from the pipeline and sets the workspace profile associated with it.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Set-PWFolderWorkspaceProfile</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Target folder object from pipeline containing sub-folders to remove the Managed Workspace object assocations.</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: WorkspaceProfile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkspaceProfile</maml:name> <maml:description> <maml:para>Workspace Profile (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: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Target folder object from pipeline containing sub-folders to remove the Managed Workspace object assocations.</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: WorkspaceProfile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkspaceProfile</maml:name> <maml:description> <maml:para>Workspace Profile (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>PWPS_DAB.CommonTypes+ProjectWiseFolder</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target folder object from pipeline containing sub-folders to remove the Managed Workspace object assocations.</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 the workspace profile for a folder.</maml:para> <maml:para>Get-PWFolders -FolderPath 'PowerShell' -JustOne | Set-PWFolderWorkspaceProfile -WorkspaceProfile 'MyWorkspaceProfile' -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFonts --> <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-PWFonts</command:name> <command:verb>Get</command:verb> <command:noun>PWFonts</command:noun> <maml:description> <maml:para>Get-PWFonts returns a list of available fonts.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWFonts</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWGroupByMatch --> <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-PWGroupByMatch</command:name> <command:verb>Remove</command:verb> <command:noun>PWGroupByMatch</command:noun> <maml:description> <maml:para>Deletes provided group(s) from the current ProjectWise datasource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes provided group(s) from the current ProjectWise datasource.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputGroups --> <command:syntaxItem> <maml:name>Remove-PWGroupByMatch</maml:name> <!-- Parameter: InputGroups --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputGroups</maml:name> <maml:description> <maml:para>Target group object(s) from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseGroup[]</command:parameterValue> <dev:type> <maml:name>PWWrapper+ProjectWiseGroup[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWWrapper+ProjectWiseGroup[]</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: GroupName --> <command:syntaxItem> <maml:name>Remove-PWGroupByMatch</maml:name> <!-- Parameter: GroupName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Group name(s) to be deleted.</maml: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: InputGroups --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputGroups</maml:name> <maml:description> <maml:para>Target group object(s) from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseGroup[]</command:parameterValue> <dev:type> <maml:name>PWWrapper+ProjectWiseGroup[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWWrapper+ProjectWiseGroup[]</dev:defaultValue> </command:parameter> <!-- Parameter: GroupName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Group name(s) to be deleted.</maml: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>PWWrapper+ProjectWiseGroup[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target group object(s) from pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>The following will remove the specified group. Remove-PWGroupByMatch -InputGroups (Get-PWGroups -GroupName 'psGroup1') -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>The following will remove the specified groups. Remove-PWGroupByMatch -GroupName 'psGroup2', 'psGroup3' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWGroupByName --> <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-PWGroupByName</command:name> <command:verb>New</command:verb> <command:noun>PWGroupByName</command:noun> <maml:description> <maml:para>Create a new ProjectWise Group.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a new ProjectWise Group. Returns a ProjectWise Group Object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: GroupName --> <command:syntaxItem> <maml:name>New-PWGroupByName</maml:name> <!-- Parameter: GroupName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Name of group 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: GroupDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupDescription</maml:name> <maml:description> <maml:para>Description of group 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: Domain --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Provide domain to add a Windows 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: GroupName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Name of group 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: GroupDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>GroupDescription</maml:name> <maml:description> <maml:para>Description of group 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: Domain --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Provide domain to add a Windows 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>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of group to be created.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>This example will create a new ProjectWise Group with Group Name ONLY. Description will be the same as the name. New-PWGroupByName -GroupName 'NewGroup' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>This example will create a new ProjectWise Group with Group Name and Domain. New-PWGroupByName -GroupName 'NewGroup' -Domain 'Bentley' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>This example will create a new ProjectWise Group with Group Name and Description. New-PWGroupByName -GroupName 'NewGroup' -Group Description 'New ProjectWise Group' -Verbose</dev:code> </command:example> </command:examples> </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> <dev:code>#Remove users from a group $groupNames = Get-PWGroupNames $users = Get-PWUsersByMatch -UserName 'dave*','bryan*' foreach ($group in $groupNames) { Remove-PWUserFromGroup $users -GroupName $group }</dev:code> </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> <dev:code>#Example usage for adding a user to the Owners of the specified Group. Set-PWGroupOwners -GroupName 'Groupies' -Owner 'MyUserName' -OwnerType 'u' #Example usage for adding a group to the Owners of the specified Group. Set-PWGroupOwners -GroupName 'Groupies' -Owner 'MyGroup' -OwnerType 'g' #Example usage for adding a userlist to the Owners of the specified Group. Set-PWPWUserListOwners -GroupName 'Groupies' -Owner 'ULA' -OwnerType 'ul'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWGroups --> <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-PWGroups</command:name> <command:verb>Get</command:verb> <command:noun>PWGroups</command:noun> <maml:description> <maml:para>Gets the ProjectWise Group(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the ProjectWise Group(s) in the current ProjectWise Datasource.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: GroupID --> <command:syntaxItem> <maml:name>Get-PWGroups</maml:name> <!-- Parameter: GroupID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>GroupID</maml:name> <maml:description> <maml:para>Retrieves the User Group with the given GroupID.</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> <!-- Parameter set: GroupName --> <command:syntaxItem> <maml:name>Get-PWGroups</maml:name> <!-- Parameter: GroupName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Retrieves only User Groups that match this GroupName. If excluded, returns all groups. Accepts 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> </command:syntax> <command:parameters> <!-- Parameter: GroupID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>GroupID</maml:name> <maml:description> <maml:para>Retrieves the User Group with the given GroupID.</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: GroupName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Retrieves only User Groups that match this GroupName. If excluded, returns all groups. Accepts 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Retrieves the User Group with the given GroupID.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Retrieves only User Groups that match this GroupName. If excluded, returns all groups. Accepts wildcards(*)</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>This example will return all ProjectWise Groups. Get-PWGroups</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>This example will return only the ProjectWise Group with the specified GroupID. Get-PWGroups -GroupID 2</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>This example will return only the ProjectWise Group which matches the specifed Group Name. Get-PWGroups -GroupName 'Restricted Administrators'</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>This example will return the ProjectWise Group(s) which match the specified Group Name with wildcards. Get-PWGroups -GroupName *Admin*</dev:code> </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> <!-- Parameter set: UserID --> <command:syntaxItem> <maml:name>Get-PWGroupsByUser</maml:name> <!-- Parameter: UserID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>UserID</maml:name> <maml:description> <maml:para>User ID to return group membership information. (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: 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> <!-- Parameter: UserID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>UserID</maml:name> <maml:description> <maml:para>User ID to return group membership information. (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>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> <dev:code>Get-PWGroupsByUser -UserName 'admin'</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-PWGroupsByUser -UserID 12</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWHierarchicalData --> <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-PWHierarchicalData</command:name> <command:verb>Get</command:verb> <command:noun>PWHierarchicalData</command:noun> <maml:description> <maml:para>Get Hierarchical Data.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWHierarchicalData</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Top level 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: PopulatePaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PopulatePaths</maml:name> <maml:description> <maml:para>Populate the PWPath member of the 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: UseDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UseDescription</maml:name> <maml:description> <maml:para>Populate the PWPath member of the object using the folder description.</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: RichProjects --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>RichProjects</maml:name> <maml:description> <maml:para>Filter for only rich projects.</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="true (ByValue)" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Top level 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: PopulatePaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PopulatePaths</maml:name> <maml:description> <maml:para>Populate the PWPath member of the 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: UseDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UseDescription</maml:name> <maml:description> <maml:para>Populate the PWPath member of the object using the folder description.</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: RichProjects --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>RichProjects</maml:name> <maml:description> <maml:para>Filter for only rich projects.</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>Top level folder path.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-HierarchicalData</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWIndexServerFileExtensionFilter --> <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-PWIndexServerFileExtensionFilter</command:name> <command:verb>Add</command:verb> <command:noun>PWIndexServerFileExtensionFilter</command:noun> <maml:description> <maml:para>Add file extensions to filter from all three index servers.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-PWIndexServerFileExtensionFilter</maml:name> <!-- Parameter: FileExtensions --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FileExtensions</maml:name> <maml:description> <maml:para>Comma delimited list of extensions e.g. "zip","bak","7zip" (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: FullText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FullText</maml:name> <maml:description> <maml:para>Set to exclude from Full Text Indexing</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: Thumbnail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Thumbnail</maml:name> <maml:description> <maml:para>Set to exclude from Thumbnail processing</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: FileProperties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>FileProperties</maml:name> <maml:description> <maml:para>Set to exclude from File Properties processing</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: FileExtensions --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FileExtensions</maml:name> <maml:description> <maml:para>Comma delimited list of extensions e.g. "zip","bak","7zip" (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: FullText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FullText</maml:name> <maml:description> <maml:para>Set to exclude from Full Text Indexing</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: Thumbnail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Thumbnail</maml:name> <maml:description> <maml:para>Set to exclude from Thumbnail processing</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: FileProperties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>FileProperties</maml:name> <maml:description> <maml:para>Set to exclude from File Properties processing</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> <dev:code>Add-PWIndexServerFileExtensionFilter -FileExtensions "zip","config","bak" -FullText -Thumbnail -FileProperties </dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWIndexServerFileExtensionFilters --> <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-PWIndexServerFileExtensionFilters</command:name> <command:verb>Get</command:verb> <command:noun>PWIndexServerFileExtensionFilters</command:noun> <maml:description> <maml:para>Get file extensions to filter from all three index servers. Default is to return all processor types.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWIndexServerFileExtensionFilters</maml:name> <!-- Parameter: FullText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>FullText</maml:name> <maml:description> <maml:para>Set to exclude from Full Text Indexing</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: Thumbnail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Thumbnail</maml:name> <maml:description> <maml:para>Set to exclude from Thumbnail processing</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: FileProperties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FileProperties</maml:name> <maml:description> <maml:para>Set to exclude from File Properties processing</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: FullText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>FullText</maml:name> <maml:description> <maml:para>Set to exclude from Full Text Indexing</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: Thumbnail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Thumbnail</maml:name> <maml:description> <maml:para>Set to exclude from Thumbnail processing</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: FileProperties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FileProperties</maml:name> <maml:description> <maml:para>Set to exclude from File Properties processing</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> <dev:code>Get-PWIndexServerFileExtensionFilters -FullText -Thumbnail -FileProperties </dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWIndexServerFileExtensionMapping --> <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-PWIndexServerFileExtensionMapping</command:name> <command:verb>Set</command:verb> <command:noun>PWIndexServerFileExtensionMapping</command:noun> <maml:description> <maml:para>Add file extension to remap for all three index servers.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWIndexServerFileExtensionMapping</maml:name> <!-- Parameter: FromExtension --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FromExtension</maml:name> <maml:description> <maml:para>From extension (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: ToExtension --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ToExtension</maml:name> <maml:description> <maml:para>To extension (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: FullText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FullText</maml:name> <maml:description> <maml:para>Set to remap for Full Text Indexing</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: Thumbnail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Thumbnail</maml:name> <maml:description> <maml:para>Set to remap for Thumbnail processing</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: FileProperties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>FileProperties</maml:name> <maml:description> <maml:para>Set to remap for File Properties processing</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: FromExtension --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FromExtension</maml:name> <maml:description> <maml:para>From extension (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: ToExtension --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ToExtension</maml:name> <maml:description> <maml:para>To extension (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: FullText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FullText</maml:name> <maml:description> <maml:para>Set to remap for Full Text Indexing</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: Thumbnail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Thumbnail</maml:name> <maml:description> <maml:para>Set to remap for Thumbnail processing</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: FileProperties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>FileProperties</maml:name> <maml:description> <maml:para>Set to remap for File Properties processing</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> <dev:code>Set-PWIndexServerExtensionMapping -FromExtension "xml" -ToExtension "txt" -FullText -Thumbnail -FileProperties </dev:code> </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: OptOutOfCentralReporting --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>OptOutOfCentralReporting</maml:name> <maml:description> <maml:para>Set this to opt out of central data collection</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: NoCleanup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>NoCleanup</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: ThrowErrorOnCreateFailure --> <command:parameter required="false" globbing="false" pipelineInput="false" position="12"> <maml:name>ThrowErrorOnCreateFailure</maml:name> <maml:description> <maml:para>Set this to throw an error if the create document step fails.</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: 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> <!-- Parameter: Storages --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Storages</maml:name> <maml:description> <maml:para>Provide a list of storage areas to test. Tests all storage areas by 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> <!-- Parameter: NumberOfFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>NumberOfFiles</maml:name> <maml:description> <maml:para>Number of files to use in test. Defaults to 5.</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: CustomerName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="8"> <maml:name>CustomerName</maml:name> <maml:description> <maml:para>Required for central reporting purposes. Users will be able to extract reports based on this value. Use something unique and descriptive. ("My company, Hosted datasources, Melbourne office")</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CustomerInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>CustomerInfo</maml:name> <maml:description> <maml:para>Optional extra information to collect about test instance (customer address, project name, etc.)</maml: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> <!-- Parameter: Storages --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Storages</maml:name> <maml:description> <maml:para>Provide a list of storage areas to test. Tests all storage areas by 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> <!-- Parameter: NumberOfFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>NumberOfFiles</maml:name> <maml:description> <maml:para>Number of files to use in test. Defaults to 5.</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: CustomerName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="8"> <maml:name>CustomerName</maml:name> <maml:description> <maml:para>Required for central reporting purposes. Users will be able to extract reports based on this value. Use something unique and descriptive. ("My company, Hosted datasources, Melbourne office")</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CustomerInfo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>CustomerInfo</maml:name> <maml:description> <maml:para>Optional extra information to collect about test instance (customer address, project name, etc.)</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OptOutOfCentralReporting --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>OptOutOfCentralReporting</maml:name> <maml:description> <maml:para>Set this to opt out of central data collection</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: NoCleanup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>NoCleanup</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: ThrowErrorOnCreateFailure --> <command:parameter required="false" globbing="false" pipelineInput="false" position="12"> <maml:name>ThrowErrorOnCreateFailure</maml:name> <maml:description> <maml:para>Set this to throw an error if the create document step fails.</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> <dev:code>#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. New-PWInputOutputPerformanceReport -OutputFileName c:\report\stats.db -FileSizeK 100 -CleanUpAuditTrail -CollectExpensiveStatistics -CustomerName "My Company, Melbourne" #SQLiteStudio seems like an adequate managment tool (http://sqlitestudio.pl/?act=download). #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. New-PWInputOutputPerformanceReport -OutputFileName c:\report\stats.xlsx -FileSizeK 100 -NumberOfFiles 10 -CleanUpAuditTrail -CollectExpensiveStatistics -CustomerName "My Company, Melbourne"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Copy-PWInterface --> <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-PWInterface</command:name> <command:verb>Copy</command:verb> <command:noun>PWInterface</command:noun> <maml:description> <maml:para>Copy-PWInterface2 copies an interface to a new definition or updates an existing one.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Copy-PWInterface copies an interface to a new definition or updates an existing one.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InterfaceName --> <command:syntaxItem> <maml:name>Copy-PWInterface</maml:name> <!-- Parameter: InterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InterfaceName</maml:name> <maml:description> <maml:para>Source Interface (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: NewInterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewInterfaceName</maml:name> <maml:description> <maml:para>New Interface 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: Environment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Environment (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: Create --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Create</maml:name> <maml:description> <maml:para>When included, the GUI will be created if it does not exist.</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: InterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InterfaceName</maml:name> <maml:description> <maml:para>Source Interface (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: NewInterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewInterfaceName</maml:name> <maml:description> <maml:para>New Interface 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: Environment --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Environment (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: Create --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Create</maml:name> <maml:description> <maml:para>When included, the GUI will be created if it does not exist.</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> <dev:code>If the NewInterfaceName does not exist, it will be NOT be created. If it does exist, it will be updated. Copy-PWInterface2 "Interface Alpha" -NewInterfaceName "Interface Beta" -Environment "Default Environment" -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>If the NewInterfaceName does not exist, it will be created. If it does exist, it will be updated. Copy-PWInterface2 "Interface Alpha" -NewInterfaceName "Interface Beta" -Environment "Default Environment" -Create -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWInterface --> <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-PWInterface</command:name> <command:verb>New</command:verb> <command:noun>PWInterface</command:noun> <maml:description> <maml:para>Creates a new interface within the current datasource.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-PWInterface</maml:name> <!-- Parameter: InterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InterfaceName</maml:name> <maml:description> <maml:para>Name of Interface 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: InterfaceDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>InterfaceDescription</maml:name> <maml:description> <maml:para>Description of Interface 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InterfaceName</maml:name> <maml:description> <maml:para>Name of Interface 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: InterfaceDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>InterfaceDescription</maml:name> <maml:description> <maml:para>Description of Interface 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> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for New-PWInterface. #Will create a new interface with a description. New-PWInterface -InterfaceName 'MyInterface' -InterfaceDescription "My New Interface" -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWInterfaceGUIDefinition --> <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-PWInterfaceGUIDefinition</command:name> <command:verb>Get</command:verb> <command:noun>PWInterfaceGUIDefinition</command:noun> <maml:description> <maml:para>Returns all attribute definitions pertaining to specified interface and environment.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWInterfaceGUIDefinition</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 use to get Interface definition 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: InterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>InterfaceName</maml:name> <maml:description> <maml:para>Interface to get GUI definition 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> </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 use to get Interface definition 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: InterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>InterfaceName</maml:name> <maml:description> <maml:para>Interface to get GUI definition 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> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for Get-PWInterfaceGUIDefinition. #Will return all attributes for the specified interface. Get-PWInterfaceGUIDefinition -EnvironmentName 'Simple' -InterfaceName 'Default' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWInterfaceGUIDefinition --> <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-PWInterfaceGUIDefinition</command:name> <command:verb>Set</command:verb> <command:noun>PWInterfaceGUIDefinition</command:noun> <maml:description> <maml:para>Set-PWInterfaceGUIDefinition allows you to add Environment attribute(s) to an Interface. Designed to facilate copying interface definitions from one datasource to another. However, can be used in the same datasource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-PWInterfaceGUIDefinition cmdlet allows you to add Environment attribute(s) to an existing Interface. Use the Get-PWInterfaceGUIDefinition cmdlet to get the desired interface definition information and use the ConvertTo-Datatable cmdlet to convert it to the correct format required.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWInterfaceGUIDefinition</maml:name> <!-- Parameter: GUIDefinition --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>GUIDefinition</maml:name> <maml:description> <maml:para>Environment to use to get Interface definition for.</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: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EnvironmentName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>InterfaceName</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: GUIDefinition --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>GUIDefinition</maml:name> <maml:description> <maml:para>Environment to use to get Interface definition for.</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: EnvironmentName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EnvironmentName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>InterfaceName</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> <dev:code>The following will get the gui definition for the 'Designer' interface from the 'Simple' environment and populate the $pwGUI variable. Then, convert the gui definition to a datatable, and finally update the 'Default' interface. The result should be a matching interface layout. $pwGUI = Get-PWInterfaceGUIDefinition -EnvironmentName 'Simple' -InterfaceName 'Designer' Set-PWInterfaceGUIDefinition -GUIDefinition(ConvertTo-Datatable $pwGUI) -EnvironmentName 'Simple' -InterfaceName 'Default' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Show-PWInterfaceGUIDefinition --> <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-PWInterfaceGUIDefinition</command:name> <command:verb>Show</command:verb> <command:noun>PWInterfaceGUIDefinition</command:noun> <maml:description> <maml:para>Displays a dialog showing an estimation of where attributes are placed on an interface. NOTE: This will not be exact and is intended to be a simple representation of the interface. Use (Get-PWEnvironments).Name to get a list of the environments available in the current datasource. Use (Get-PWEnvironmentColumns -EnvironmentName 'Simple').Name to get a list of the the available columns for a specified environment. Use (Get-PWInterfaces).Values to get a list of the available interfaces. Use Show-PWInterfaceGUIDefinition to see a representation of an interface.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Show-PWInterfaceGUIDefinition</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 use to get Interface definition 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: InterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>InterfaceName</maml:name> <maml:description> <maml:para>Interface to get GUI definition 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> </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 use to get Interface definition 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: InterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>InterfaceName</maml:name> <maml:description> <maml:para>Interface to get GUI definition 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> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for Show-PWInterfaceGUIDefinition. Show-PWInterfaceGUIDefinition -EnvironmentName "Simple" -InterfaceName "Default" -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWInterfaceGUILabel --> <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-PWInterfaceGUILabel</command:name> <command:verb>Set</command:verb> <command:noun>PWInterfaceGUILabel</command:noun> <maml:description> <maml:para>Sets interface label for the provided environment, interface, and attribute. Use (Get-PWEnvironments).Name to get a list of the environments available in the current datasource. Use (Get-PWEnvironmentColumns -EnvironmentName 'Simple').Name to get a list of the the available columns for a specified environment. Use (Get-PWInterfaces).Values to get a list of the available interfaces.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWInterfaceGUILabel</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 use to update Interface definition.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>InterfaceName</maml:name> <maml:description> <maml:para>Interface name to use when updating the attribute label text.</maml:para> </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="2"> <maml:name>AttributeName</maml:name> <maml:description> <maml:para>Attribute name to update the label for in the GUI definition.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LabelText --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>LabelText</maml:name> <maml:description> <maml:para>Label text used to update GUI definition.</maml: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 use to update Interface definition.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>InterfaceName</maml:name> <maml:description> <maml:para>Interface name to use when updating the attribute label text.</maml:para> </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="2"> <maml:name>AttributeName</maml:name> <maml:description> <maml:para>Attribute name to update the label for in the GUI definition.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LabelText --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>LabelText</maml:name> <maml:description> <maml:para>Label text used to update GUI definition.</maml: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> <dev:code>#Example usage for Set-PWInterfaceGUILabel. Set-PWInterfaceGUILabel -EnvironmentName "Simple" -InterfaceName "Default" -AttributeName "Column_03" -LabelText "COLUMN 03:" -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWInterfaceGUILabelFont --> <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-PWInterfaceGUILabelFont</command:name> <command:verb>Set</command:verb> <command:noun>PWInterfaceGUILabelFont</command:noun> <maml:description> <maml:para>Sets interface label font and/or font height for the provided environment, interface, and attribute. Use (Get-PWEnvironments).Name to get a list of the environments available in the current datasource. Use (Get-PWEnvironmentColumns -EnvironmentName 'Simple').Name to get a list of the the available columns for a specified environment. Use (Get-PWInterfaces).Values to get a list of the available interfaces. Use Get-PWFonts to get a list of available fonts.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWInterfaceGUILabelFont</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 use to update Interface definition.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>InterfaceName</maml:name> <maml:description> <maml:para>Interface to update GUI definition 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>AttributeName</maml:name> <maml:description> <maml:para>Attribute name to update the GUI definition.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LabelFont --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>LabelFont</maml:name> <maml:description> <maml:para>Label font used to update GUI definition.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LabelFontHeight --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>LabelFontHeight</maml:name> <maml:description> <maml:para>Label font height used to update GUI definition.</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>Environment to use to update Interface definition.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>InterfaceName</maml:name> <maml:description> <maml:para>Interface to update GUI definition 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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>AttributeName</maml:name> <maml:description> <maml:para>Attribute name to update the GUI definition.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LabelFont --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>LabelFont</maml:name> <maml:description> <maml:para>Label font used to update GUI definition.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LabelFontHeight --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>LabelFontHeight</maml:name> <maml:description> <maml:para>Label font height used to update GUI definition.</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> <dev:code>#Example usage for Set-PWInterfaceGUILabelFont. Set-PWInterfaceGUILabelFont -EnvironmentName "Simple" -InterfaceName "Default" -AttributeName "Column_03" -LabelFont "Calibri" -LabelHeight 12 -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWInterfaceGUIPrompt --> <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-PWInterfaceGUIPrompt</command:name> <command:verb>Set</command:verb> <command:noun>PWInterfaceGUIPrompt</command:noun> <maml:description> <maml:para>Sets the interface prompt for the provided environment, interface, and attribute. Use (Get-PWEnvironments).Name to get a list of the environments available in the current datasource. Use (Get-PWEnvironmentColumns -EnvironmentName 'Simple').Name to get a list of the the available columns for a specified environment. Use (Get-PWInterfaces).Values to get a list of the available interfaces.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-PWInterfaceGUIPrompt</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 use to update Interface definition.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>InterfaceName</maml:name> <maml:description> <maml:para>Interface name to use when updating the attribute prompt.</maml:para> </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="2"> <maml:name>AttributeName</maml:name> <maml:description> <maml:para>Attribute name to update the prompt for in the GUI definition.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Prompt --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Prompt</maml:name> <maml:description> <maml:para>Prompt value used to update GUI definition.</maml: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 use to update Interface definition.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InterfaceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>InterfaceName</maml:name> <maml:description> <maml:para>Interface name to use when updating the attribute prompt.</maml:para> </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="2"> <maml:name>AttributeName</maml:name> <maml:description> <maml:para>Attribute name to update the prompt for in the GUI definition.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Prompt --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Prompt</maml:name> <maml:description> <maml:para>Prompt value used to update GUI definition.</maml: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> <dev:code>#Example usage for Set-PWInterfaceGUIPrompt. Set-PWInterfaceGUIPrompt -EnvironmentName "Simple" -InterfaceName "Default" -AttributeName "Column_03" -Prompt "Enter value for COLUMN 03." -Verbose</dev:code> </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> <maml:description> <maml:para>Get-PWInterfaces returns all interface ids and names.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-PWInterfaces is used to get the names and ids of all interfaces within the active datasource.</maml:para> </maml:description> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for getting all interfaces in the datasouce. Import-Module pwps_dab Get-PWInterfaces</dev:code> </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> <dev:code>Example usage for creating a PDF file from an IPS file. 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> <dev:code>Example usage for adding a document to an IPS file. 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> <maml:description> <maml:para>Specifies the user name in which to log into IPlot with. If not specified, the current user 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: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserPassword</maml:name> <maml:description> <maml:para>"Specifies the user password to be used to log into IPlot. This is 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: IPSFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>IPSFolderPath</maml:name> <maml:description> <maml:para>"Specifies the folder name to create the new IPS file 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: IPSFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>IPSFileName</maml:name> <maml:description> <maml:para>Specifies the IPS file name in which to add the document(s).</maml: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>Specifies the user name in which to log into IPlot with. If not specified, the current user 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: UserPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserPassword</maml:name> <maml:description> <maml:para>"Specifies the user password to be used to log into IPlot. This is 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: IPSFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>IPSFolderPath</maml:name> <maml:description> <maml:para>"Specifies the folder name to create the new IPS file 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: IPSFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>IPSFileName</maml:name> <maml:description> <maml:para>Specifies the IPS file name in which to add the document(s).</maml: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> <dev:code>Example usage for creating new IPS file. 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> <dev:code>Example usage to get the plots within an IPS file. 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> <dev:code>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. 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> <dev:code>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. 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> <dev:code>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. 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> <dev:code>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. 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> <!-- Parameter: BentleyIMS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>BentleyIMS</maml:name> <maml:description> <maml:para>Use Connection Client to log 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> <!-- Parameter: LoadWRE --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>LoadWRE</maml:name> <maml:description> <maml:para>Load Workflow Rules Engine</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: NonAdminLogin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>NonAdminLogin</maml:name> <maml:description> <maml:para>Login as a non-admin user. User must be member of "PowerShell Users" group in 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> <!-- Parameter: Token --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>Token</maml:name> <maml:description> <maml:para>Use with -BentleyIMS</maml: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: 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> <!-- Parameter: BentleyIMS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>BentleyIMS</maml:name> <maml:description> <maml:para>Use Connection Client to log 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> <!-- Parameter: LoadWRE --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>LoadWRE</maml:name> <maml:description> <maml:para>Load Workflow Rules Engine</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: NonAdminLogin --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>NonAdminLogin</maml:name> <maml:description> <maml:para>Login as a non-admin user. User must be member of "PowerShell Users" group in 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> <!-- Parameter: Token --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>Token</maml:name> <maml:description> <maml:para>Use with -BentleyIMS</maml: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> <dev:code>#logical user login $encryptedPassword = Read-Host -Prompt "Enter Password:" -AsSecureString New-PWLogin Server:DSN -UserName UserName -Password $encryptedPassword</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Single sign-on login. Non-admin login. User must be in "PowerShell Users" group. New-PWLogin Server:DSN -DoNotCreateWorkingDirectory -NonAdminLogin</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>#IMS login. Load Workflow Rules Engine. New-PWLogin Server:DSN -BentleyIMS -LoadWRE</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>#Use dialog to login. Non-admin login. User must be in "PowerShell Users" group. New-PWLogin -UseGUI -NonAdminLogin</dev:code> </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> <dev:code>Regular logout Undo-PWLogin</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Move-PWLogInOutAuditTrailRecords --> <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-PWLogInOutAuditTrailRecords</command:name> <command:verb>Move</command:verb> <command:noun>PWLogInOutAuditTrailRecords</command:noun> <maml:description> <maml:para>Moves user login/logout audit trail entries from the primary audit trail table to the secondary.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Dates --> <command:syntaxItem> <maml:name>Move-PWLogInOutAuditTrailRecords</maml:name> <!-- Parameter: StartDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>StartDate</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EndDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EndDate</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: StartDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>StartDate</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EndDate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EndDate</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> <dev:code>Moves all user login/logout records to the secondary audit trail table. Move-PWLogInOutAuditTrailRecords -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Moves all user login/logout records between the two provided dates to the secondary audit trail table. Move-PWLogInOutAuditTrailRecords -StartDate 04/01/2018 -EndDate 04/05/2018 -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Moves all user login/logout records between the start date provided and the current date to the secondary audit trail table. Move-PWLogInOutAuditTrailRecords -StartDate 04/01/2018 -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWLoginStatus --> <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-PWLoginStatus</command:name> <command:verb>Get</command:verb> <command:noun>PWLoginStatus</command:noun> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Import-PWLookupTableFromDataTable --> <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-PWLookupTableFromDataTable</command:name> <command:verb>Import</command:verb> <command:noun>PWLookupTableFromDataTable</command:noun> <maml:description> <maml:para>Write the values from a datatable into a table in the PW database for lookup table maintenance.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputTable --> <command:syntaxItem> <maml:name>Import-PWLookupTableFromDataTable</maml:name> <!-- Parameter: InputTable --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputTable</maml:name> <maml:description> <maml:para>Data Table object to import (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: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Table name to insert values into (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: Append --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Append</maml:name> <maml:description> <maml:para>Set this to preserve existing rows.</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: DropFirst --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DropFirst</maml:name> <maml:description> <maml:para>Set this to preserve existing rows.</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: InputTable --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputTable</maml:name> <maml:description> <maml:para>Data Table object to import (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: TableName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TableName</maml:name> <maml:description> <maml:para>Table name to insert values into (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: Append --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Append</maml:name> <maml:description> <maml:para>Set this to preserve existing rows.</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: DropFirst --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>DropFirst</maml:name> <maml:description> <maml:para>Set this to preserve existing rows.</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>Data Table object to import (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$connectionString="DSN=OracleInstant;Pwd=pass" $query="select * from v_filepurpose" $conn = New-Object System.Data.Odbc.OdbcConnection $conn.ConnectionString = $connectionString $conn.open() $cmd = New-object System.Data.Odbc.OdbcCommand($query,$conn) $ds = New-Object system.Data.DataSet (New-Object system.Data.odbc.odbcDataAdapter($cmd)).fill($ds) | out-null $conn.close() Import-PWLookupTableFromDataTable $ds.Tables[0] -TableName MyLookupTable -DropFirst</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-PWLookupTablesFromXLSX --> <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-PWLookupTablesFromXLSX</command:name> <command:verb>Import</command:verb> <command:noun>PWLookupTablesFromXLSX</command:noun> <maml:description> <maml:para>Write the values from a workbook into tables in the PW database for lookup table maintenance.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFile --> <command:syntaxItem> <maml:name>Import-PWLookupTablesFromXLSX</maml:name> <!-- Parameter: InputFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFile</maml:name> <maml:description> <maml:para>Data Table object to import (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: Append --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Append</maml:name> <maml:description> <maml:para>Set this to preserve existing rows.</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: DropFirst --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DropFirst</maml:name> <maml:description> <maml:para>Set this to preserve existing rows.</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="true (ByValue)" position="0"> <maml:name>InputFile</maml:name> <maml:description> <maml:para>Data Table object to import (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: Append --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Append</maml:name> <maml:description> <maml:para>Set this to preserve existing rows.</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: DropFirst --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DropFirst</maml:name> <maml:description> <maml:para>Set this to preserve existing rows.</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>Data Table object to import (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Import-PWLookupTablesFromXLSX c:\temp\LookupTables.xlsx -DropFirst</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Export-PWLookupTablesToXLSX --> <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-PWLookupTablesToXLSX</command:name> <command:verb>Export</command:verb> <command:noun>PWLookupTablesToXLSX</command:noun> <maml:description> <maml:para>Write values from the PW database lookup tables to a workbook for easy maintenance.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: OutputFile --> <command:syntaxItem> <maml:name>Export-PWLookupTablesToXLSX</maml:name> <!-- Parameter: OutputFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>File name for output (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: TableNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TableNames</maml:name> <maml:description> <maml:para>List names to get specific 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: OutputFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>File name for output (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: TableNames --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TableNames</maml:name> <maml:description> <maml:para>List names to get specific 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>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>File name for output (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Export-PWLookupTablesToXLSX c:\temp\LookupTables.xlsx</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Copy-PWMailMessagesFromExchange --> <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-PWMailMessagesFromExchange</command:name> <command:verb>Copy</command:verb> <command:noun>PWMailMessagesFromExchange</command:noun> <maml:description> <maml:para>Copy email messages from Exchange or Office 365 to ProjectWise.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: MailPassword --> <command:syntaxItem> <maml:name>Copy-PWMailMessagesFromExchange</maml:name> <!-- Parameter: MappingFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>MappingFile</maml:name> <maml:description> <maml:para>This is a spreadsheet with the columns SubjectKey, TargetFolder, FolderURN. The FolderURN can be populated with "Copy URN" values from the ProjectWise Explorer address bar. Target folder is the full path to an existing folder (e.g. 'Project 1\Correspondence\Email Messages').</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: MailUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>MailUser</maml:name> <maml:description> <maml:para>Pass a mail user name like 'joe.blow@bentley.com'.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MailPassword --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>MailPassword</maml:name> <maml:description> <maml:para>Password for the mail user.</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: ExchangeURL --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>ExchangeURL</maml:name> <maml:description> <maml:para>Exchange URL (defaults to https://outlook.office365.com/EWS/Exchange.asmx) .</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>https://outlook.office365.com/EWS/Exchange.asmx</dev:defaultValue> </command:parameter> <!-- Parameter: DeleteMessageAfterImport --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>DeleteMessageAfterImport</maml:name> <maml:description> <maml:para>Set this to delete email after copy to ProjectWise.</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: MaxMessagesToRetrieve --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>MaxMessagesToRetrieve</maml:name> <maml:description> <maml:para>Maximum number of messages to retrieve. Defaults to 100.</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> <!-- Parameter: HoursOld --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="6"> <maml:name>HoursOld</maml:name> <maml:description> <maml:para>How many hours old for querying emails. Defaults to 1.</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> </command:syntaxItem> <!-- Parameter set: UseDefaultCredentials --> <command:syntaxItem> <maml:name>Copy-PWMailMessagesFromExchange</maml:name> <!-- Parameter: MappingFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>MappingFile</maml:name> <maml:description> <maml:para>This is a spreadsheet with the columns SubjectKey, TargetFolder, FolderURN. The FolderURN can be populated with "Copy URN" values from the ProjectWise Explorer address bar. Target folder is the full path to an existing folder (e.g. 'Project 1\Correspondence\Email Messages').</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: MailUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>MailUser</maml:name> <maml:description> <maml:para>Pass a mail user name like 'joe.blow@bentley.com'.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseDefaultCredentials --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>UseDefaultCredentials</maml:name> <maml:description> <maml:para>Set this to delete email after copy to ProjectWise.</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: ExchangeURL --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>ExchangeURL</maml:name> <maml:description> <maml:para>Exchange URL (defaults to https://outlook.office365.com/EWS/Exchange.asmx) .</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>https://outlook.office365.com/EWS/Exchange.asmx</dev:defaultValue> </command:parameter> <!-- Parameter: DeleteMessageAfterImport --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>DeleteMessageAfterImport</maml:name> <maml:description> <maml:para>Set this to delete email after copy to ProjectWise.</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: MaxMessagesToRetrieve --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>MaxMessagesToRetrieve</maml:name> <maml:description> <maml:para>Maximum number of messages to retrieve. Defaults to 100.</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> <!-- Parameter: HoursOld --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="6"> <maml:name>HoursOld</maml:name> <maml:description> <maml:para>How many hours old for querying emails. Defaults to 1.</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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: MailUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>MailUser</maml:name> <maml:description> <maml:para>Pass a mail user name like 'joe.blow@bentley.com'.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MailPassword --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>MailPassword</maml:name> <maml:description> <maml:para>Password for the mail user.</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: UseDefaultCredentials --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>UseDefaultCredentials</maml:name> <maml:description> <maml:para>Set this to delete email after copy to ProjectWise.</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: MappingFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>MappingFile</maml:name> <maml:description> <maml:para>This is a spreadsheet with the columns SubjectKey, TargetFolder, FolderURN. The FolderURN can be populated with "Copy URN" values from the ProjectWise Explorer address bar. Target folder is the full path to an existing folder (e.g. 'Project 1\Correspondence\Email Messages').</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: ExchangeURL --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>ExchangeURL</maml:name> <maml:description> <maml:para>Exchange URL (defaults to https://outlook.office365.com/EWS/Exchange.asmx) .</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>https://outlook.office365.com/EWS/Exchange.asmx</dev:defaultValue> </command:parameter> <!-- Parameter: DeleteMessageAfterImport --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>DeleteMessageAfterImport</maml:name> <maml:description> <maml:para>Set this to delete email after copy to ProjectWise.</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: MaxMessagesToRetrieve --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>MaxMessagesToRetrieve</maml:name> <maml:description> <maml:para>Maximum number of messages to retrieve. Defaults to 100.</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> <!-- Parameter: HoursOld --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="6"> <maml:name>HoursOld</maml:name> <maml:description> <maml:para>How many hours old for querying emails. Defaults to 1.</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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Pass a mail user name like 'joe.blow@bentley.com'.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Password for the mail user.</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>Set this to delete email after copy to ProjectWise.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseDocument</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>This is a spreadsheet with the columns SubjectKey, TargetFolder, FolderURN. The FolderURN can be populated with "Copy URN" values from the ProjectWise Explorer address bar. Target folder is the full path to an existing folder (e.g. 'Project 1\Correspondence\Email Messages').</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Exchange URL (defaults to https://outlook.office365.com/EWS/Exchange.asmx) .</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>Set this to delete email after copy to ProjectWise.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Maximum number of messages to retrieve. Defaults to 100.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>How many hours old for querying emails. Defaults to 1.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$doc = Get-PWDocumentsBySearch -FolderPath 'Some folder\Path' -DocumentName 'EmailMappings.xlsx' Copy-PWMailMessagesFromExchange $doc -MailUser joe.blow@bentley.com -MailPassword (Read-Host "Mail Password:" -AsSecureString) -HoursOld 6</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWManagedWorkspaceAssociationFromFolders --> <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-PWManagedWorkspaceAssociationFromFolders</command:name> <command:verb>Remove</command:verb> <command:noun>PWManagedWorkspaceAssociationFromFolders</command:noun> <maml:description> <maml:para>Removes specified configuration block from input folders.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolders --> <command:syntaxItem> <maml:name>Remove-PWManagedWorkspaceAssociationFromFolders</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> <!-- Parameter: WorkspaceType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkspaceType</maml:name> <maml:description> <maml:para>Select the type of Managed workspace containing the desired configuration settings block to be used. Valid entries: "Predefined", "Global", "Application", "Customer", "Site", "Workspace", "WorkSet", "Role", "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: ConfigurationBlockName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ConfigurationBlockName</maml:name> <maml:description> <maml:para>Name of configuration block to remove association from project. Use Get-PWManagedWorkspaceConfigBlocks to get a list of available configuration blocks.</maml: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="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> <!-- Parameter: WorkspaceType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkspaceType</maml:name> <maml:description> <maml:para>Select the type of Managed workspace containing the desired configuration settings block to be used. Valid entries: "Predefined", "Global", "Application", "Customer", "Site", "Workspace", "WorkSet", "Role", "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: ConfigurationBlockName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ConfigurationBlockName</maml:name> <maml:description> <maml:para>Name of configuration block to remove association from project. Use Get-PWManagedWorkspaceConfigBlocks to get a list of available configuration blocks.</maml: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> <dev:code>Get-PWFolders -FolderPath 'Top Level\Sub-Folder' | Remove-PWManagedWorkspaceAssocationFromFolders -WorkspaceType 'WorkSet' -ConfigurationBlockName 'MyConfigBlockName' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>$folders = Get-PWFolders -FolderPath 'Top Level\Sub-Folder' Remove-PWManagedWorkspaceAssocationFromFolders -InputFolders $folders -WorkspaceType 'WorkSet' -ConfigurationBlockName 'MyConfigBlockName' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWManagedWorkspaceAssociationsFromSubFolders --> <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-PWManagedWorkspaceAssociationsFromSubFolders</command:name> <command:verb>Remove</command:verb> <command:noun>PWManagedWorkspaceAssociationsFromSubFolders</command:noun> <maml:description> <maml:para>Removes ALL managed workspace object assocations from SUB-FOLDERS of specified folder.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Remove-PWManagedWorkspaceAssociationsFromSubFolders</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Target folder object from pipeline containing sub-folders to remove the Managed Workspace object assocations.</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> </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>Target folder object from pipeline containing sub-folders to remove the Managed Workspace object assocations.</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> </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 from pipeline containing sub-folders to remove the Managed Workspace object assocations.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWFolders -FolderPath 'Top Level\Sub-Folder' | Remove-PWManagedWorkspaceAssocationsFromSubFolders -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWManagedWorkspaceConfigBlocks --> <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-PWManagedWorkspaceConfigBlocks</command:name> <command:verb>Get</command:verb> <command:noun>PWManagedWorkspaceConfigBlocks</command:noun> <maml:description> <maml:para>Get the managed workspace configuration settings blocks for all or a specified type of Managed Workspace. Valid types: "All", "Predefined", "Global", "Application", "Customer", "Site", "Workspace", "WorkSet", "Role", "User"</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWManagedWorkspaceConfigBlocks</maml:name> <!-- Parameter: WorkspaceType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkspaceType</maml:name> <maml:description> <maml:para>Select the type of Managed workspace to return the configuration settings blocks for. Valid entries: "All", "Predefined", "Global", "Application", "Customer", "Site", "Workspace", "WorkSet", "Role", "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: WorkspaceType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkspaceType</maml:name> <maml:description> <maml:para>Select the type of Managed workspace to return the configuration settings blocks for. Valid entries: "All", "Predefined", "Global", "Application", "Customer", "Site", "Workspace", "WorkSet", "Role", "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:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Returns the configuration blocks for all Managed Workspace types. Get-PWAllManagedWorkspaces -WorkspaceType 'All' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Returns the configuration blocks for Managed Workspace type Site. Get-PWAllManagedWorkspaceConfigBlocks -WorkspaceType 'Site' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWManagedWorkspaceConfigurationBlock --> <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-PWManagedWorkspaceConfigurationBlock</command:name> <command:verb>New</command:verb> <command:noun>PWManagedWorkspaceConfigurationBlock</command:noun> <maml:description> <maml:para>Creates a new Managed Workspace configuration block.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-PWManagedWorkspaceConfigurationBlock</maml:name> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of new workspace configuration block.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of new workspace configuration block.</maml:para> </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="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of new workspace configuration block.</maml: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: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of new workspace configuration block.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of new workspace configuration block.</maml:para> </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="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of new workspace configuration block.</maml: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> <dev:code>New-PWManagedWorkspaceConfigurationBlock -Type Global -Name 'MyGlobalWorkspace' -Description 'My Global Workspace' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWManagedWorkspaceConfigurationBlock --> <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-PWManagedWorkspaceConfigurationBlock</command:name> <command:verb>Remove</command:verb> <command:noun>PWManagedWorkspaceConfigurationBlock</command:noun> <maml:description> <maml:para>Removes a Workspace configuration block.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-PWManagedWorkspaceConfigurationBlock</maml:name> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of workspace configuration block to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of workspace configuration block to delete.</maml: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: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of workspace configuration block to delete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of workspace configuration block to delete.</maml: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> <dev:code>Remove-PWManagedWorkspaceConfigurationBlock -Type Global -Name 'MyGlobalWorkspace' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWManagedWorkspaceConfigurationBlock --> <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-PWManagedWorkspaceConfigurationBlock</command:name> <command:verb>Update</command:verb> <command:noun>PWManagedWorkspaceConfigurationBlock</command:noun> <maml:description> <maml:para>Updates the name and / or description of a Workspace configuration block.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-PWManagedWorkspaceConfigurationBlock</maml:name> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of workspace configuration block 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: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of workspace configuration block 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: NewName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name to update workspace configuration block with.</maml:para> </maml:description> <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="3"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>New description to update workspace configuration block with.</maml: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: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>Type of workspace configuration block 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: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of workspace configuration block 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: NewName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name to update workspace configuration block with.</maml:para> </maml:description> <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="3"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>New description to update workspace configuration block with.</maml: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> <dev:code>Update-PWManagedWorkspaceConfigurationBlock -Type Global -Name 'MyGlobalWorkspace' -NewName 'NewWorkspaceName' -NewDescription 'Updated Workspace Description' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWManagedWorkspaceForFolders --> <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-PWManagedWorkspaceForFolders</command:name> <command:verb>Set</command:verb> <command:noun>PWManagedWorkspaceForFolders</command:noun> <maml:description> <maml:para>Associates the specified Managed Workspace Configuration Block to the Input Folder(s).</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolders --> <command:syntaxItem> <maml:name>Set-PWManagedWorkspaceForFolders</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> <!-- Parameter: WorkspaceType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>WorkspaceType</maml:name> <maml:description> <maml:para>Select the type of Managed Workspace containing the desired configuration settings block to be used. Valid entries: "Predefined", "Global", "Application", "Customer", "Site", "Workspace", "WorkSet", "Role", "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: ConfigurationBlockName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ConfigurationBlockName</maml:name> <maml:description> <maml:para>Name of configuration block to be added to project. Use Get-PWManagedWorkspaceConfigBlocks to get a list of available configuration blocks.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoInheritance --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoInheritance</maml:name> <maml:description> <maml:para>When included, inheritance will be toggled off for the 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: 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> <!-- Parameter: WorkspaceType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>WorkspaceType</maml:name> <maml:description> <maml:para>Select the type of Managed Workspace containing the desired configuration settings block to be used. Valid entries: "Predefined", "Global", "Application", "Customer", "Site", "Workspace", "WorkSet", "Role", "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: ConfigurationBlockName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ConfigurationBlockName</maml:name> <maml:description> <maml:para>Name of configuration block to be added to project. Use Get-PWManagedWorkspaceConfigBlocks to get a list of available configuration blocks.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NoInheritance --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoInheritance</maml:name> <maml:description> <maml:para>When included, inheritance will be toggled off for the 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+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> <dev:code>Associates MyConfigBlockName to the folder's Managed Workspace type Workset/Project. Turns off inheritance. Get-PWFolders -FolderPath 'Top Level\Sub-Folder' -JustOne | Set-PWManagedWorkspaceForFolders -WorkspaceType 'WorkSet' -ConfigurationBlockName 'MyConfigBlockName' -NoInheritance -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Associates MyConfigBlockName to each of the folder's Managed Workspace type Workset/Project. $folders = Get-PWFolders -FolderPath 'Top Level\Sub-Folder' Set-PWManagedWorkspaceForFolders -InputFolders $folders -WorkspaceType 'WorkSet' -ConfigurationBlockName 'MyConfigBlockName' -Verbose</dev:code> </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> <dev:code>Get-PWFolders -FolderPah 'Top Level\Sub-Folder' | Get-PWManagedWorkspaces</dev:code> </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> <dev:code>Get-PWRichProjects | Get-PWManagedWorkspaces | Get-PWManagedWorkspaceVariables</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWMemberFromUserList --> <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-PWMemberFromUserList</command:name> <command:verb>Remove</command:verb> <command:noun>PWMemberFromUserList</command:noun> <maml:description> <maml:para>Remove ProjectWise Users, Groups or other User Lists from a ProjectWise User List.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputUser --> <command:syntaxItem> <maml:name>Remove-PWMemberFromUserList</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 remove from 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>Name of UserList 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="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>UserNames</maml:name> <maml:description> <maml:para>Array of user names to remove from 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: GroupNames --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>GroupNames</maml:name> <maml:description> <maml:para>Array of group names to remove from 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: UserListNames --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>UserListNames</maml:name> <maml:description> <maml:para>Array of user list names to be removed from 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: RemoveAllUsers --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>RemoveAllUsers</maml:name> <maml:description> <maml:para>Remove all users setting from User 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: 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 remove from 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>Name of UserList 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="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>UserNames</maml:name> <maml:description> <maml:para>Array of user names to remove from 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: GroupNames --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>GroupNames</maml:name> <maml:description> <maml:para>Array of group names to remove from 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: UserListNames --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>UserListNames</maml:name> <maml:description> <maml:para>Array of user list names to be removed from 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: RemoveAllUsers --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>RemoveAllUsers</maml:name> <maml:description> <maml:para>Remove all users setting from User 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>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user objects from the pipeline to remove from user list.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user names to remove from UserList.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of group names to remove from UserList.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user list names to be removed from UserList.</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>Remove all users setting from User List.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for Remove-PWMemberFromUserList. Get-PWUsersByMatch -UserName 'dave*','bryan*' -Email '*@bentley.com' | Remove-PWMemberFromUserList -UserList "Project Managers" Remove-PWMemberFromUserList -UserNames "dave","brian" -GroupNames "Restricted Administrators", "PowerShell Users" -UserListNames "UserList 2" -UserList "Project Managers"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWMembers --> <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-PWMembers</command:name> <command:verb>Get</command:verb> <command:noun>PWMembers</command:noun> <maml:description> <maml:para>Returns all members of a group or userlist.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Name --> <command:syntaxItem> <maml:name>Get-PWMembers</maml:name> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>Access control type. Either Group or UserList. (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: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Group or Userlist name to return 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: Type --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>Access control type. Either Group or UserList. (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: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Group or Userlist name to return 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> <dev:code>Get-PWMembers -Type Group -Name 'ProjectWise Administrators' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-PWMembers -Type UserList -Name 'MyUserList' -Verbose</dev:code> </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> <dev:code>#Example usage for Add-PWMemberToGroup. Get-PWUsersByMatch -UserName 'dave*','bryan*' -Email '*@bentley.com' | Add-PWMemberToGroup -GroupName "Design" Add-PWMemberToGroup -UserNames "dave","brian" -GroupName "Design"</dev:code> </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 ProjectWise Users, Groups or other User Lists 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 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>Name of UserList to add members 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="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>UserNames</maml:name> <maml:description> <maml:para>Array of user names to add to 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: GroupNames --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>GroupNames</maml:name> <maml:description> <maml:para>Array of group names to add to 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: UserListNames --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>UserListNames</maml:name> <maml:description> <maml:para>Array of user list names to add to 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: AddAllUsers --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>AddAllUsers</maml:name> <maml:description> <maml:para>Add all users setting.</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: 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 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>Name of UserList to add members 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="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>UserNames</maml:name> <maml:description> <maml:para>Array of user names to add to 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: GroupNames --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>GroupNames</maml:name> <maml:description> <maml:para>Array of group names to add to 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: UserListNames --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>UserListNames</maml:name> <maml:description> <maml:para>Array of user list names to add to 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: AddAllUsers --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>AddAllUsers</maml:name> <maml:description> <maml:para>Add all users setting.</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>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:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user names to add to UserList.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of group names to add to UserList.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of user list names to add to UserList.</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>Add all users setting.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for Add-PWMemberToUserList. Get-PWUsersByMatch -UserName 'dave*','bryan*' -Email '*@bentley.com' | Add-PWMemberToUserList -UserList "Project Managers" Add-PWMemberToUserList -UserNames "dave","brian" -GroupNames "Restricted Administrators", "PowerShell Users" -UserListNames "UserList 2" -UserList "Project Managers"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Edit-PWMicroStationDocuments --> <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>Edit-PWMicroStationDocuments</command:name> <command:verb>Edit</command:verb> <command:noun>PWMicroStationDocuments</command:noun> <maml:description> <maml:para>Checks out, processes and checks in CADD files.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Edit-PWMicroStationDocuments</maml:name> <!-- Parameter: InputDocuments --> <command:parameter required="false" 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: EngineNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EngineNumber</maml:name> <maml:description> <maml:para>Engine Number to use (see Get-MicroStationEngines).</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: KeyIn --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>KeyIn</maml:name> <maml:description> <maml:para>Valid key-in string to run in MicroStation (e.g. "view off all;view on 3;view top;xy=0,0,0,3;fit view extended;xy=0,0,0,3;filedesign").</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseRunningEngine --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>UseRunningEngine</maml:name> <maml:description> <maml:para>Use a running instance of MicroStation (requires EngineNumber to be set). You may need to use a running instance to get around the no workset issue.</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>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: EngineNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EngineNumber</maml:name> <maml:description> <maml:para>Engine Number to use (see Get-MicroStationEngines).</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: KeyIn --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>KeyIn</maml:name> <maml:description> <maml:para>Valid key-in string to run in MicroStation (e.g. "view off all;view on 3;view top;xy=0,0,0,3;fit view extended;xy=0,0,0,3;filedesign").</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseRunningEngine --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>UseRunningEngine</maml:name> <maml:description> <maml:para>Use a running instance of MicroStation (requires EngineNumber to be set). You may need to use a running instance to get around the no workset issue.</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> <dev:code>$docs = $docs=Get-PWDocumentsBySearch -FolderPath (Show-PWFolderBrowserDialog).FullPath -FileName %.dgn Edit-PWMicroStationDocuments $docs -KeyIn "view off all;view on 3;view top;xy=0,0,0,3;fit view extended;xy=0,0,0,3;filedesign"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWMissingStorageAreaFiles --> <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-PWMissingStorageAreaFiles</command:name> <command:verb>Get</command:verb> <command:noun>PWMissingStorageAreaFiles</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWMissingStorageAreaFiles</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 ProjectWise folder to report 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: UseAdminPaths --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>UseAdminPaths</maml:name> <maml:description> <maml:para>When UseAdminPaths is included, administrative paths to the files will be used..</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: FolderProgressInterval --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>FolderProgressInterval</maml:name> <maml:description> <maml:para>Vary the amount of folder progress reporting. Defaults to reporting after 20 folders. Set to 0 to suppress.</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>20</dev:defaultValue> </command:parameter> <!-- Parameter: DocumentProgressInterval --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>DocumentProgressInterval</maml:name> <maml:description> <maml:para>Vary the amount of document progress reporting. Defaults to reporting progress after every 1000 documents. Set to 0 to suppress.</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>1000</dev:defaultValue> </command:parameter> <!-- Parameter: ShowStorageFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>ShowStorageFolders</maml:name> <maml:description> <maml:para>Set to show every folder to be searched if -Debug switch is used. Should be avoided for performance reasons.</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: ConnectionString --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>Connection string for SQL database.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationTable --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="6"> <maml:name>DestinationTable</maml:name> <maml:description> <maml:para>Name of the target table for the SQL Bulk Copy.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RunID --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="7"> <maml:name>RunID</maml:name> <maml:description> <maml:para>Run ID.</maml: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 ProjectWise folder to report 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: UseAdminPaths --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>UseAdminPaths</maml:name> <maml:description> <maml:para>When UseAdminPaths is included, administrative paths to the files will be used..</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: FolderProgressInterval --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>FolderProgressInterval</maml:name> <maml:description> <maml:para>Vary the amount of folder progress reporting. Defaults to reporting after 20 folders. Set to 0 to suppress.</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>20</dev:defaultValue> </command:parameter> <!-- Parameter: DocumentProgressInterval --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>DocumentProgressInterval</maml:name> <maml:description> <maml:para>Vary the amount of document progress reporting. Defaults to reporting progress after every 1000 documents. Set to 0 to suppress.</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>1000</dev:defaultValue> </command:parameter> <!-- Parameter: ShowStorageFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>ShowStorageFolders</maml:name> <maml:description> <maml:para>Set to show every folder to be searched if -Debug switch is used. Should be avoided for performance reasons.</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: ConnectionString --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>Connection string for SQL database.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DestinationTable --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="6"> <maml:name>DestinationTable</maml:name> <maml:description> <maml:para>Name of the target table for the SQL Bulk Copy.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RunID --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="7"> <maml:name>RunID</maml:name> <maml:description> <maml:para>Run ID.</maml: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 ProjectWise folder to report on.</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>When UseAdminPaths is included, administrative paths to the files will be used..</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Vary the amount of folder progress reporting. Defaults to reporting after 20 folders. Set to 0 to suppress.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Vary the amount of document progress reporting. Defaults to reporting progress after every 1000 documents. Set to 0 to suppress.</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>Set to show every folder to be searched if -Debug switch is used. Should be avoided for performance reasons.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Connection string for SQL database.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of the target table for the SQL Bulk Copy.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Run ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage Get-PWMissingStorageAreaFiles. $docs = Get-PWMissingStorageAreaFiles foreach ($doc in $docs) { $doc.FullPathToStorageAreaFile }</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWMonthlyCheckOutsByProject --> <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-PWMonthlyCheckOutsByProject</command:name> <command:verb>Get</command:verb> <command:noun>PWMonthlyCheckOutsByProject</command:noun> <maml:description> <maml:para>Gets monthly document checkouts per user and project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets monthly document checkouts per user and project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWMonthlyCheckOutsByProject</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> <!-- Parameter: Month --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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="2"> <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="3"> <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: WholeYear --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>WholeYear</maml:name> <maml:description> <maml:para>If set, generate report for the whole year.</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: DataTable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>DataTable</maml:name> <maml:description> <maml:para>If set, output a data table of the results.</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="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: Month --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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="2"> <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="3"> <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: WholeYear --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>WholeYear</maml:name> <maml:description> <maml:para>If set, generate report for the whole year.</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: DataTable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>DataTable</maml:name> <maml:description> <maml:para>If set, output a data table of the results.</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 ProjectWise folders from pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Get all the rich projects in this tree and pass to this cmdlet $rps = Get-PWRichProjects -FolderPath "PWPS Connected Project Test 6\Projects 2" Get-PWMonthlyCheckOutsByProjectDataTable $rps -Year 2017 -Month 5 Get-PWMonthlyCheckOutsByProjectDataTable $rps -Year 2017 -WholeYear</dev:code> </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.Unnecessary, because backup audit trail table is always 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> <!-- Parameter: OnlyPrimary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnlyPrimary</maml:name> <maml:description> <maml:para>When included, ONLY the audit trail records from the Primary audit 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> <!-- Parameter: WholeYear --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WholeYear</maml:name> <maml:description> <maml:para>If set, generate report for the whole year.</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: OnlyPrimary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnlyPrimary</maml:name> <maml:description> <maml:para>When included, ONLY the audit trail records from the Primary audit 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> <!-- 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.Unnecessary, because backup audit trail table is always 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> <!-- Parameter: WholeYear --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WholeYear</maml:name> <maml:description> <maml:para>If set, generate report for the whole year.</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> <dev:code>#Will count user logins by month and save to spreadsheet. Get-PWMonthlyLogins -Month 9 -Year 2015 -OutputFileName "201509Logins.xlsx" #Will count user logins for the current month. Get-PWMonthlyLogins</dev:code> </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. Unnecessary because backup audit trail table is always 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> <!-- Parameter: OnlyPrimary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnlyPrimary</maml:name> <maml:description> <maml:para>When included, ONLY the audit trail records from the Primary audit 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> <!-- Parameter: WholeYear --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WholeYear</maml:name> <maml:description> <maml:para>If set, generate report for the whole year.</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: OnlyPrimary --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OnlyPrimary</maml:name> <maml:description> <maml:para>When included, ONLY the audit trail records from the Primary audit 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> <!-- 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. Unnecessary because backup audit trail table is always 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> <!-- Parameter: WholeYear --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WholeYear</maml:name> <maml:description> <maml:para>If set, generate report for the whole year.</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> <dev:code>#Will count user logins by month and output to data table on pipeline. Get-PWMonthlyLoginsDataTable -Month 9 -Year 2015" #Will count user logins for the current month. Get-PWMonthlyLoginsDataTable</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWNonFederatedLoginToken --> <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-PWNonFederatedLoginToken</command:name> <command:verb>Get</command:verb> <command:noun>PWNonFederatedLoginToken</command:noun> <maml:description> <maml:para>Get Login Token in various forms.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWNonFederatedLoginToken</maml:name> <!-- Parameter: UserName --> <command:parameter required="true" 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: Password --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password.</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: CreateWebToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>CreateWebToken</maml:name> <maml:description> <maml:para>Token suitable for creating Connected Projects and Project Shares, etc. Base64 encrypted string.</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: AppliesTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>AppliesTo</maml:name> <maml:description> <maml:para>Arbitrary "Applies To" address for future use.</maml: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="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: Password --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password.</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: CreateWebToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>CreateWebToken</maml:name> <maml:description> <maml:para>Token suitable for creating Connected Projects and Project Shares, etc. Base64 encrypted string.</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: AppliesTo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>AppliesTo</maml:name> <maml:description> <maml:para>Arbitrary "Applies To" address for future use.</maml: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> <dev:code>#Get token for use with New-PWLogin -BentleyIMS -Token $token $token = Get-PWNonFederatedLoginToken -UserName user@co.com -Password $pwd New-PWLogin decide-pwce-us.bentley.com:decide-pwce-us-10 -BentleyIMS -Token $token #Get token for use with Connected Project and Project Share commands $webtoken = Get-PWNonFederatedLoginToken -UserName user@co.com -Password $pwd -CreateWebToken Add-PWConnectedProject -InputFolder $rp2 -ConnectedProjectName "Alpha Bravo Charlie" -ConnectedProjectNumber "AlphaBravoCharlie" -MakeUnique -Location 'Durham, NC' -AssetType 'Airport' -WSGURL 'https://decide-pwce-us-ws.bentley.com/ws' -Token $webtoken</dev:code> </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>Create and update AAODS and PW Components tables and classes. And Creates dmsSystem folder and subfolders and other items required for PW Components datasources, if they have not already been created. No parameters available.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Add-PWODSTables -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Invoke-PWOrchestrationFrameworkScript --> <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>Invoke-PWOrchestrationFrameworkScript</command:name> <command:verb>Invoke</command:verb> <command:noun>PWOrchestrationFrameworkScript</command:noun> <maml:description> <maml:para>Run a script against Orchestration Framework database.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Invoke-PWOrchestrationFrameworkScript</maml:name> <!-- Parameter: DatabaseServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>DatabaseServer</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabaseName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabaseUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>DatabaseUser</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabasePwd --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>DatabasePwd</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database password.</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: UseWindowsAuth --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>UseWindowsAuth</maml:name> <maml:description> <maml:para>Switch to use Windows Authentication.</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: ScriptFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>ScriptFile</maml:name> <maml:description> <maml:para>Full path to script file to run. Must be text file with one command per line.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseTransaction --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="6"> <maml:name>UseTransaction</maml:name> <maml:description> <maml:para>Wrap the script in Begin Transaction/Commit Transaction.</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: DatabaseServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>DatabaseServer</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabaseName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabaseUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>DatabaseUser</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabasePwd --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>DatabasePwd</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database password.</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: UseWindowsAuth --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>UseWindowsAuth</maml:name> <maml:description> <maml:para>Switch to use Windows Authentication.</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: ScriptFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>ScriptFile</maml:name> <maml:description> <maml:para>Full path to script file to run. Must be text file with one command per line.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UseTransaction --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="6"> <maml:name>UseTransaction</maml:name> <maml:description> <maml:para>Wrap the script in Begin Transaction/Commit Transaction.</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>Orchestration Framework/iCS database server.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Orchestration Framework/iCS database name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Orchestration Framework/iCS database user.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Orchestration Framework/iCS database password.</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>Switch to use Windows Authentication.</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 script file to run. Must be text file with one command per line.</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>Wrap the script in Begin Transaction/Commit Transaction.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Invoke-PWOrchestrationFrameworkScript -ServerName -DatabaseName OF -UseWindowsAuth -ScriptFile SQLCommands.txt"</dev:code> </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 object array, 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: InputFolders --> <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: InputFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolders</maml:name> <maml:description> <maml:para>Array of ProjectWise folders from pipeline. These folders will be included in report if they are rich projects and have CONNECTed projects.</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: 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="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Output file name for 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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="5"> <maml:name>Token</maml:name> <maml:description> <maml:para>CONNECT Token.</maml: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 ProjectWise folders from pipeline. These folders will be included in report if they are rich projects and have CONNECTed projects.</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>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="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Output file name for 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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Obsolete.</maml:para> </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>Obsolete.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="5"> <maml:name>Token</maml:name> <maml:description> <maml:para>CONNECT Token.</maml: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 ProjectWise folders from pipeline. These folders will be included in report if they are rich projects and have CONNECTed projects.</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> <dev:code>#Example usage for reporting on outgoing transmittals for a CONNECTED project. #Will report on the Outgoing Transmittals for the CONNECTed Project associated with the ProjectWise Rich Project identified by that path Get-PWOutgoingTransmittalsReport -FolderPath "PWPS Connected Project Test 6\Projects 2\Project A" -OutputFileName "c:\\temp\\xmittalReport.xlsx"</dev:code> </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> <dev:code>#Example usage for getting the folder path information. $pwBinPath = Get-PWPath</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWPDFDigitalSignature --> <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-PWPDFDigitalSignature</command:name> <command:verb>Add</command:verb> <command:noun>PWPDFDigitalSignature</command:noun> <maml:description> <maml:para>Apply a PDF digital signature to PDFs in ProjectWise.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Add-PWPDFDigitalSignature</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 sign (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: PDFSignatureFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>PDFSignatureFile</maml:name> <maml:description> <maml:para>Path and file name of PDF file containing signature. File is expected to be outside of ProjectWise.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Reason --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>Reason</maml:name> <maml:description> <maml:para>Reason for signing.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Contact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>Contact</maml:name> <maml:description> <maml:para>Person to contact.</maml:para> </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="12"> <maml:name>Location</maml:name> <maml:description> <maml:para>Location.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StampInForeground --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>StampInForeground</maml:name> <maml:description> <maml:para>Stamp in Foreground (stamps in background by default).</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="2"> <maml:name>OutputFolder</maml:name> <maml:description> <maml:para>Folder outside of ProjectWise where the signed PDFs are written.</maml:para> </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 signature.</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 signature.</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 signature.</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>99</dev:defaultValue> </command:parameter> <!-- Parameter: UseTimestampServer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>UseTimestampServer</maml:name> <maml:description> <maml:para>If true, use timestamp server.</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: TimeStampServerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>TimeStampServerName</maml:name> <maml:description> <maml:para>Time stamp server name. Only used if UserTimstampServer passed as true.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TimeStampServerUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>TimeStampServerUser</maml:name> <maml:description> <maml:para>Time stamp server user. Only used if UserTimstampServer passed as true.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TimeStampServerPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>TimeStampServerPassword</maml:name> <maml:description> <maml:para>Time stamp server passord. Only used if UserTimstampServer passed as true.</maml: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 sign (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: PDFSignatureFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>PDFSignatureFile</maml:name> <maml:description> <maml:para>Path and file name of PDF file containing signature. File is expected to be outside of ProjectWise.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OutputFolder</maml:name> <maml:description> <maml:para>Folder outside of ProjectWise where the signed PDFs are written.</maml:para> </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 signature.</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 signature.</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 signature.</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>99</dev:defaultValue> </command:parameter> <!-- Parameter: UseTimestampServer --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>UseTimestampServer</maml:name> <maml:description> <maml:para>If true, use timestamp server.</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: TimeStampServerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>TimeStampServerName</maml:name> <maml:description> <maml:para>Time stamp server name. Only used if UserTimstampServer passed as true.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TimeStampServerUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>TimeStampServerUser</maml:name> <maml:description> <maml:para>Time stamp server user. Only used if UserTimstampServer passed as true.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TimeStampServerPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>TimeStampServerPassword</maml:name> <maml:description> <maml:para>Time stamp server passord. Only used if UserTimstampServer passed as true.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Reason --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>Reason</maml:name> <maml:description> <maml:para>Reason for signing.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Contact --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>Contact</maml:name> <maml:description> <maml:para>Person to contact.</maml:para> </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="12"> <maml:name>Location</maml:name> <maml:description> <maml:para>Location.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StampInForeground --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>StampInForeground</maml:name> <maml:description> <maml:para>Stamp in Foreground (stamps in background by default).</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 sign (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Sentence1. Sentence2. Sentence3. Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder' -FileName %.pdf | Add-PWPDFDigitalSignature -WSGURL "https://decide-pwce-us-ws.bentley.com/ws/v2.5/Repositories/Bentley.PW--decide-pwce-us.bentley.com~3Adecide-pwce-us-10" #URL can be anything. #Try NativeUnits flag if QR Code is too small or invisible. Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder' -FileName %.pdf | Add-PWPDFQRCode -URL "http://www.bentley.com"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWPDFLink --> <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-PWPDFLink</command:name> <command:verb>Add</command:verb> <command:noun>PWPDFLink</command:noun> <maml:description> <maml:para>Apply a link to a PDF in ProjectWise. (Marty suggested this months ago and I'm just getting around to it).</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Add-PWPDFLink</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: LinkText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>LinkText</maml:name> <maml:description> <maml:para>Link text to use. If not set, will use document 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: 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: Width --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Width</maml:name> <maml:description> <maml:para>Width of the link.</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> <!-- Parameter: Height --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Height</maml:name> <maml:description> <maml:para>Height of the link.</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>25</dev:defaultValue> </command:parameter> <!-- Parameter: TextSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>TextSize</maml:name> <maml:description> <maml:para>Text size for link text. (Defaults to 10).</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>10</dev:defaultValue> </command:parameter> <!-- Parameter: NativeUnits --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>NativeUnits</maml:name> <maml:description> <maml:para>Units are in PDF Units. This will vary depending on how the PDF is created. Try changing if your link does not show up where expected</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: FriendlyLinkPrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>FriendlyLinkPrefix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>https://projectwiseconnector.azurewebsites.net/api/GetProcessGmailLink?code=zBBTVzTLoCXyxzYs/eme6FmqAnOnQBRHQHnNHl55aNpOS59HfWapQA==&timeout=3000&pwlink=</dev:defaultValue> </command:parameter> <!-- Parameter: MakeFriendlyProjectWiseLink --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>MakeFriendlyProjectWiseLink</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: 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: Width --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Width</maml:name> <maml:description> <maml:para>Width of the link.</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> <!-- Parameter: Height --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Height</maml:name> <maml:description> <maml:para>Height of the link.</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>25</dev:defaultValue> </command:parameter> <!-- Parameter: TextSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>TextSize</maml:name> <maml:description> <maml:para>Text size for link text. (Defaults to 10).</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>10</dev:defaultValue> </command:parameter> <!-- Parameter: NativeUnits --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>NativeUnits</maml:name> <maml:description> <maml:para>Units are in PDF Units. This will vary depending on how the PDF is created. Try changing if your link does not show up where expected</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: MakeFriendlyProjectWiseLink --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>MakeFriendlyProjectWiseLink</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: FriendlyLinkPrefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>FriendlyLinkPrefix</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>https://projectwiseconnector.azurewebsites.net/api/GetProcessGmailLink?code=zBBTVzTLoCXyxzYs/eme6FmqAnOnQBRHQHnNHl55aNpOS59HfWapQA==&timeout=3000&pwlink=</dev:defaultValue> </command:parameter> <!-- Parameter: LinkText --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>LinkText</maml:name> <maml:description> <maml:para>Link text to use. If not set, will use document 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: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> <dev:code>#Will put a ProjectWise Link on a PDF. Get-PWDocumentsBySearch -FolderPath "QR Codes\MSV Rao" | Add-PWPDFLink -X 100 -Y 100 -Width 200 -Height 20 -TextSize 20 -NativeUnits -MakeFriendlyProjectWiseLink</dev:code> </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 PDFs 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: StampInForeground --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>StampInForeground</maml:name> <maml:description> <maml:para>Stamp in Foreground (stamps in background by default).</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: 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. Works best in multiples of 33 due to the way QR Code image is generated.</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>99</dev:defaultValue> </command:parameter> <!-- Parameter: NativeUnits --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>NativeUnits</maml:name> <maml:description> <maml:para>(Obsolete, not used.) Units are in PDF Units.</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: CropBorder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>CropBorder</maml:name> <maml:description> <maml:para>(Obsolete, not used.) Number of units to crop around the edge of the QR Code (can have a lot of white border based on the size of the 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>0</dev:defaultValue> </command:parameter> <!-- Parameter: RemoveImages --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>RemoveImages</maml:name> <maml:description> <maml:para>(Obsolete, not used). Remove the existing images.</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: DoNotShortenURL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>DoNotShortenURL</maml:name> <maml:description> <maml:para>Do not shorten URL.</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: 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. Works best in multiples of 33 due to the way QR Code image is generated.</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>99</dev:defaultValue> </command:parameter> <!-- Parameter: NativeUnits --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>NativeUnits</maml:name> <maml:description> <maml:para>(Obsolete, not used.) Units are in PDF Units.</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: CropBorder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>CropBorder</maml:name> <maml:description> <maml:para>(Obsolete, not used.) Number of units to crop around the edge of the QR Code (can have a lot of white border based on the size of the 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>0</dev:defaultValue> </command:parameter> <!-- Parameter: RemoveImages --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>RemoveImages</maml:name> <maml:description> <maml:para>(Obsolete, not used). Remove the existing images.</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: DoNotShortenURL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>DoNotShortenURL</maml:name> <maml:description> <maml:para>Do not shorten URL.</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: StampInForeground --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>StampInForeground</maml:name> <maml:description> <maml:para>Stamp in Foreground (stamps in background by default).</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:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#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. 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" #URL can be anything. #Try NativeUnits flag if QR Code is too small or invisible. Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder' -FileName %.pdf | Add-PWPDFQRCode -URL "http://www.bentley.com"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Read-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>Read-PWPDFQRCode</command:name> <command:verb>Read</command:verb> <command:noun>PWPDFQRCode</command:noun> <maml:description> <maml:para>Read QR Code from a PDF in ProjectWise. Returns array of strings from the value on each page in PDF.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Read-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: X --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>X</maml:name> <maml:description> <maml:para>X coordinate of lower left corner of code image. (0, 0 is top left of page)</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="2"> <maml:name>Y</maml:name> <maml:description> <maml:para>Y coordinate of lower left corner of code image. (0, 0 is top left of page)</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="3"> <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> <!-- Parameter: IsBarCode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>IsBarCode</maml:name> <maml:description> <maml:para>Set if expecting barcode instead of QR Code.</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: SaveCroppedImages --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>SaveCroppedImages</maml:name> <maml:description> <maml:para>Save cropped images (for debugging X, Y and Size).</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: X --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>X</maml:name> <maml:description> <maml:para>X coordinate of lower left corner of code image. (0, 0 is top left of page)</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="2"> <maml:name>Y</maml:name> <maml:description> <maml:para>Y coordinate of lower left corner of code image. (0, 0 is top left of page)</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="3"> <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> <!-- Parameter: IsBarCode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>IsBarCode</maml:name> <maml:description> <maml:para>Set if expecting barcode instead of QR Code.</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: SaveCroppedImages --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>SaveCroppedImages</maml:name> <maml:description> <maml:para>Save cropped images (for debugging X, Y and Size).</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:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#0,0 is top left of page. Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder' -FileName %.pdf | Read-PWPDFQRCode -X 100 -Y 100 -Size 100</dev:code> </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 ProjectWise folder path 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> <!-- Parameter: ReplaceExisting --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReplaceExisting</maml:name> <maml:description> <maml:para>When included, if the target document exists, it will be replaced.</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: VersionExisting --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VersionExisting</maml:name> <maml:description> <maml:para>When included, if the target document exists, it will be versioned.</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: OutputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>OutputFolder</maml:name> <maml:description> <maml:para>Target ProjectWise folder path 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> <!-- Parameter: ReplaceExisting --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReplaceExisting</maml:name> <maml:description> <maml:para>When included, if the target document exists, it will be replaced.</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: VersionExisting --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VersionExisting</maml:name> <maml:description> <maml:para>When included, if the target document exists, it will be versioned.</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.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target ProjectWise folder path 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> <dev:code>#use a variable to hold all the returned documents so they are passed to the merge process properly $pdfs = Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder' -FileName %.pdf Merge-PWPDFs $pdfs -OutputFolder 'Merged\PDFs' -Verbose</dev:code> </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> <dev:code>Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder' -FileName %.pdf | Split-PWPDFs New-PWPDFMergedDocument $pdfs -OutputFolder 'Merged\PDFs' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Reset-PWPDFText --> <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-PWPDFText</command:name> <command:verb>Reset</command:verb> <command:noun>PWPDFText</command:noun> <maml:description> <maml:para>Replace text in a PDF in ProjectWise.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Reset-PWPDFText</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 replace text for (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: ReplacementText --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ReplacementText</maml:name> <maml:description> <maml:para>Hashtable of replacement text strings. Hashtable in PowerShell looks like this @{'Find Value 1' = 'Replace Value 1'; 'Find Value 2' = 'Replace Value 2' }</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: TextColor --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>TextColor</maml:name> <maml:description> <maml:para>Color to rewrite text. (e.g. Red, Blue, Green, Cyan, Black)</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ForceLeftAlign --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>ForceLeftAlign</maml:name> <maml:description> <maml:para>Force text to be left aligned</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: ZIndex --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>ZIndex</maml:name> <maml:description> <maml:para>Change text priority</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: BoxText --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>BoxText</maml:name> <maml:description> <maml:para>Force text to be left aligned</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 replace text for (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: ReplacementText --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ReplacementText</maml:name> <maml:description> <maml:para>Hashtable of replacement text strings. Hashtable in PowerShell looks like this @{'Find Value 1' = 'Replace Value 1'; 'Find Value 2' = 'Replace Value 2' }</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: TextColor --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>TextColor</maml:name> <maml:description> <maml:para>Color to rewrite text. (e.g. Red, Blue, Green, Cyan, Black)</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ForceLeftAlign --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>ForceLeftAlign</maml:name> <maml:description> <maml:para>Force text to be left aligned</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: ZIndex --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>ZIndex</maml:name> <maml:description> <maml:para>Change text priority</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: BoxText --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>BoxText</maml:name> <maml:description> <maml:para>Force text to be left aligned</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 replace text for (Required).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Hashtable of replacement text strings. Hashtable in PowerShell looks like this @{'Find Value 1' = 'Replace Value 1'; 'Find Value 2' = 'Replace Value 2' }</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Color to rewrite text. (e.g. Red, Blue, Green, Cyan, Black)</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>Force text to be left aligned</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Change text priority</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>Force text to be left aligned</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Will replace the 'Find' values with the 'Replace' values and write them back in Red. Get-PWDocumentsBySearch -FolderPath "QR Codes\MSV Rao" | Reset-PWPDFText -ReplacementText @{'Find Value 1' = 'Replace Value 1'; 'Find Value 2' = 'Replace Value 2'} -TextColor Red</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWPDFWatermarkText --> <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-PWPDFWatermarkText</command:name> <command:verb>Add</command:verb> <command:noun>PWPDFWatermarkText</command:noun> <maml:description> <maml:para>Add text watermark to the PDF.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Add-PWPDFWatermarkText</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: Text --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Text</maml:name> <maml:description> <maml:para>Watermark Text.</maml:para> </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="true (ByValue)" position="2"> <maml:name>X</maml:name> <maml:description> <maml:para>X coordinate of watermark. Default is 50.</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>50</dev:defaultValue> </command:parameter> <!-- Parameter: Y --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>Y</maml:name> <maml:description> <maml:para>Y coordinate of watermark. Default is 50.</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>50</dev:defaultValue> </command:parameter> <!-- Parameter: TextSize --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>TextSize</maml:name> <maml:description> <maml:para>Text size for link text. (Defaults to 10).</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>10</dev:defaultValue> </command:parameter> <!-- Parameter: Opacity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>Opacity</maml:name> <maml:description> <maml:para>Opacity. (Defaults to 50, 100 = completly opaque).</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>50</dev:defaultValue> </command:parameter> <!-- Parameter: Rotation --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="6"> <maml:name>Rotation</maml:name> <maml:description> <maml:para>Rotation degrees. (Defaults to 0).</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: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="7"> <maml:name>Color</maml:name> <maml:description> <maml:para>Foreground color for text. (Default is Black).</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>Black</dev:defaultValue> </command:parameter> <!-- Parameter: Font --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="8"> <maml:name>Font</maml:name> <maml:description> <maml:para>Font for text. (Default is Helvetica).</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>Helvetica</dev:defaultValue> </command:parameter> <!-- Parameter: WatermarkInForeground --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="9"> <maml:name>WatermarkInForeground</maml:name> <maml:description> <maml:para>Put watermark in the foreground.</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: Text --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Text</maml:name> <maml:description> <maml:para>Watermark Text.</maml:para> </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="true (ByValue)" position="2"> <maml:name>X</maml:name> <maml:description> <maml:para>X coordinate of watermark. Default is 50.</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>50</dev:defaultValue> </command:parameter> <!-- Parameter: Y --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>Y</maml:name> <maml:description> <maml:para>Y coordinate of watermark. Default is 50.</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>50</dev:defaultValue> </command:parameter> <!-- Parameter: TextSize --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>TextSize</maml:name> <maml:description> <maml:para>Text size for link text. (Defaults to 10).</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>10</dev:defaultValue> </command:parameter> <!-- Parameter: Opacity --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>Opacity</maml:name> <maml:description> <maml:para>Opacity. (Defaults to 50, 100 = completly opaque).</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>50</dev:defaultValue> </command:parameter> <!-- Parameter: Rotation --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="6"> <maml:name>Rotation</maml:name> <maml:description> <maml:para>Rotation degrees. (Defaults to 0).</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: Color --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="7"> <maml:name>Color</maml:name> <maml:description> <maml:para>Foreground color for text. (Default is Black).</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>Black</dev:defaultValue> </command:parameter> <!-- Parameter: Font --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="8"> <maml:name>Font</maml:name> <maml:description> <maml:para>Font for text. (Default is Helvetica).</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>Helvetica</dev:defaultValue> </command:parameter> <!-- Parameter: WatermarkInForeground --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="9"> <maml:name>WatermarkInForeground</maml:name> <maml:description> <maml:para>Put watermark in the foreground.</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.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Watermark Text.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>X coordinate of watermark. Default is 50.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Y coordinate of watermark. Default is 50.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Text size for link text. (Defaults to 10).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Opacity. (Defaults to 50, 100 = completly opaque).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Double</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Rotation degrees. (Defaults to 0).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Foreground color for text. (Default is Black).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Font for text. (Default is Helvetica).</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>Put watermark in the foreground.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Will put a ProjectWise Link on a PDF. Get-PWDocumentsBySearch -FolderPath "QR Codes\MSV Rao" | Add-PWPDFWatermarkText $doc -Text "Do NOT Use!" -X 200 -Y 150 -TextSize 300 -Opacity 10 -Rotation 30 -Color LightCyan -Font TimesBoldItalic</dev:code> </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> <dev:code>#Example usage for adding a new custom picklist. Add-PWPicklist -PicklistName 'MyPicklist' -PicklistValues 'one', 'two', 'three' -Verbose</dev:code> </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> <dev:code>#Example usage for retrieving all custom picklist information. Export-PWPicklist -OutputFile c:\temp\picklists.xlsx</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Example usage for retrieiving information for an individual custom picklist. Export-PWPicklist -OutputFile c:\temp\picklists.xlsx -PicklistName 'MyPickList'</dev:code> </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> <dev:code>#Example usage for retrieving all custom picklist information. Get-PWPicklist -Verbose</dev:code> </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> <dev:code>#Example usage for retrieving all custom picklist information. Import-PWPicklist -InputFile c:\temp\picklists.xlsx</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Example usage for overwriting individual custom picklist. Import-PWPicklist -InputFile c:\temp\picklists.xlsx -PicklistName 'MyPickList'</dev:code> </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> <dev:code>#Example usage for removing a custom picklist. Remove-PWPicklist -PicklistName 'MyPicklist' -Verbose</dev:code> </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> <dev:code>#Example usage for removing an item from a custom picklist. Remove-PWPicklistItem -PicklistName 'MyPicklist' -PicklistValues 'one' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Example usage for removing multiple items from a custom picklist. Remove-PWPicklistItem -PicklistName 'MyPicklist' -PicklistValues 'two', 'three' -Verbose</dev:code> </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> <dev:code>#Example usage for retrieving all custom picklist information. Get-PWPicklist -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Example usage for retrieiving information for an individual custom picklist. Get-PWPicklist -PicklistName 'MyPicklist' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWPowerShellScript --> <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-PWPowerShellScript</command:name> <command:verb>New</command:verb> <command:noun>PWPowerShellScript</command:noun> <maml:description> <maml:para>Create a new PW PowerShell script with header.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: OutputFile --> <command:syntaxItem> <maml:name>New-PWPowerShellScript</maml:name> <!-- Parameter: OutputFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>Output file 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: ScriptType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ScriptType</maml:name> <maml:description> <maml:para>Script type.</maml:para> <maml:para>Possible values: Default, Archive_Full, Archive_Export, Archive_Import</maml:para> </maml:description> <command:parameterValue required="true">PWScriptType</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonScriptCommands+PWScriptType</maml:name> <maml:uri /> <maml:description> <maml:para>Tagset types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Default</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">Archive_Full</command:parameterValue> <command:parameterValue required="false" variableLength="false">Archive_Export</command:parameterValue> <command:parameterValue required="false" variableLength="false">Archive_Import</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Script 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: Purpose --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Purpose</maml:name> <maml:description> <maml:para>Purpose of script.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Author --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Author</maml:name> <maml:description> <maml:para>Author of script.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Overwrite --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrite existing 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: OutputFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>Output file 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: ScriptType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ScriptType</maml:name> <maml:description> <maml:para>Script type.</maml:para> <maml:para>Possible values: Default, Archive_Full, Archive_Export, Archive_Import</maml:para> </maml:description> <command:parameterValue required="true">PWScriptType</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.CommonScriptCommands+PWScriptType</maml:name> <maml:uri /> <maml:description> <maml:para>Tagset types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>Default</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" variableLength="false">Archive_Full</command:parameterValue> <command:parameterValue required="false" variableLength="false">Archive_Export</command:parameterValue> <command:parameterValue required="false" variableLength="false">Archive_Import</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Script 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: Purpose --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Purpose</maml:name> <maml:description> <maml:para>Purpose of script.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Author --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Author</maml:name> <maml:description> <maml:para>Author of script.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Overwrite --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrite existing 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>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Output file name (required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>New-PWPowerShellScript "c:\users\user.name\Documents\MyScript.ps1" -Name "AutomateThis" -Purpose "Automate something" -Author "PowerShell Scripter" -Overwrite</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Export-PWProjectAccessControl --> <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-PWProjectAccessControl</command:name> <command:verb>Export</command:verb> <command:noun>PWProjectAccessControl</command:noun> <maml:description> <maml:para>Export-PWProjectAccessControl is used to export out access control for a project/folder/work area to a datatable, Excel spreadsheet or SQLite database.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Exports out access control from a folder(s) to a datatable by default. Exports to an Excel spreadsheet or SQLite database based on the value passed in the ExportFilePathName parameter.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Export-PWProjectAccessControl</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Source 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> </command:parameter> <!-- Parameter: FolderLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderLevel</maml:name> <maml:description> <maml:para>Level of folders to return access control for. Zero is the default which returns all access control entries for entire folder structure. Use FolderLevel of one for source folder only.</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: ExportFilePathName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ExportFilePathName</maml:name> <maml:description> <maml:para>Used to specify local folder path and file name to export access control data to. Must be either .xlsx (Excel) or .sqlite (SQLite Database) file 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> </command:syntaxItem> <!-- Parameter set: FolderPath --> <command:syntaxItem> <maml:name>Export-PWProjectAccessControl</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Source 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: FolderLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderLevel</maml:name> <maml:description> <maml:para>Level of folders to return access control for. Zero is the default which returns all access control entries for entire folder structure. Use FolderLevel of one for source folder only.</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: ExportFilePathName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ExportFilePathName</maml:name> <maml:description> <maml:para>Used to specify local folder path and file name to export access control data to. Must be either .xlsx (Excel) or .sqlite (SQLite Database) file 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> </command:syntaxItem> <!-- Parameter set: FolderID --> <command:syntaxItem> <maml:name>Export-PWProjectAccessControl</maml:name> <!-- Parameter: FolderID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FolderID</maml:name> <maml:description> <maml:para>Source folder ID.</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: FolderLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderLevel</maml:name> <maml:description> <maml:para>Level of folders to return access control for. Zero is the default which returns all access control entries for entire folder structure. Use FolderLevel of one for source folder only.</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: ExportFilePathName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ExportFilePathName</maml:name> <maml:description> <maml:para>Used to specify local folder path and file name to export access control data to. Must be either .xlsx (Excel) or .sqlite (SQLite Database) file 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> </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>Source 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> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Source 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: FolderID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>FolderID</maml:name> <maml:description> <maml:para>Source folder ID.</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: FolderLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderLevel</maml:name> <maml:description> <maml:para>Level of folders to return access control for. Zero is the default which returns all access control entries for entire folder structure. Use FolderLevel of one for source folder only.</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: ExportFilePathName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ExportFilePathName</maml:name> <maml:description> <maml:para>Used to specify local folder path and file name to export access control data to. Must be either .xlsx (Excel) or .sqlite (SQLite Database) file 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Source folder object(s) 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>Source folder path.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Source folder ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for exporting ALL access control from a project to a datatable by passing ONE InputFolder object. $accessControlObjects = Export-PWProjectAccessControl -InputFolder (Get-PWFolders -FolderPath 'PowerShell\PowerShell_Test' -JustOne) -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Example usage for exporting ALL access control from a project to a datatable by passing a FolderPath. $accessControlObjects = Export-PWProjectAccessControl -FolderPath 'PowerShell\PowerShell_Test' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>#Example usage for exporting ALL access control from a project to a datatable by passing a Folder ID. $accessControlObjects = Export-PWProjectAccessControl -FolderID 69212 -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>#Example usage for exporting access control from a project to a datatable. Only the first (source) folder's access control objects will be returned. $accessControlObjects = Export-PWProjectAccessControl -FolderPath 'PowerShell\PowerShell_Test' -FolderLevel 1 -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>#Example usage for exporting access control from a project to a datatable. Only the first two folders levels access control objects will be returned. $accessControlObjects = Export-PWProjectAccessControl -FolderID 69212 -FolderLevel 2 -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>#Example usage for exporting access control from a project to an Excel spreadsheet. All project access control will be exported using default values. Passing the InputFolder via the pipeline. Get-PWFolders -FolderPath 'PowerShell\PowerShell_Test' -JustOne | Export-PWProjectAccessControl -ExportFilePathName 'd:\temp\export\MyAccessControl.xlsx' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 7 ----------</maml:title> <dev:code>#Example usage for exporting access control from a project to a SQLite database. All project access control will be exported. Passing the InputFolder via the pipeline. Get-PWFolders -FolderPath 'PowerShell\PowerShell_Test' -JustOne | Export-PWProjectAccessControl -FolderLevel 0 -ExportFilePathName 'd:\temp\export\MyAccessControl_01.sqlite' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 8 ----------</maml:title> <dev:code>#Example usage for exporting access control from a project to a SQLite database. Only the access control objects for the first three folders levels will be exported. Passing the InputFolder via the pipeline. Get-PWFolders -FolderPath 'PowerShell\PowerShell_Test' -JustOne | Export-PWProjectAccessControl -FolderLevel 3 -ExportFilePathName 'd:\temp\export\MyAccessControl_02.sqlite' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-PWProjectAccessControl --> <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-PWProjectAccessControl</command:name> <command:verb>Import</command:verb> <command:noun>PWProjectAccessControl</command:noun> <maml:description> <maml:para>Import-PWProjectAccessControl will update project access control based on the access control settings imported from the specified datatable, Excel spreadsheet or SQLite database.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use to update a projects access control settings in its entirety. Or import the access control data into a datatable. Use the Export-PWProjectAccessControl to export the access control to a datatable, spreadsheet or SQLite database.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ImportFile --> <command:syntaxItem> <maml:name>Import-PWProjectAccessControl</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Target folder object from pipeline. If excluded, a datatable will be returned.</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: ImportFilePathName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ImportFilePathName</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> <!-- Parameter set: Datatable --> <command:syntaxItem> <maml:name>Import-PWProjectAccessControl</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Target folder object from pipeline. If excluded, a datatable will be returned.</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: ImportDatatable --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ImportDatatable</maml:name> <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: InputFolder --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Target folder object from pipeline. If excluded, a datatable will be returned.</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: ImportFilePathName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ImportFilePathName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ImportDatatable --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ImportDatatable</maml:name> <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>PWPS_DAB.CommonTypes+ProjectWiseFolder</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target folder object from pipeline. If excluded, a datatable will be returned.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Updates the access control for the specified project, based on the information imported in from the spreadsheet. Get-PWFolders -FolderID 69989 -JustOne | Import-PWProjectAccessControl -ImportFilePathName d:\temp\import\projectaccesscontrol.xlsx </dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Updates the access control for the specified project, based on the information imported in from the SQLite database. $pwFolders = Get-PWFolders -FolderID 69989 -JustOne; Import-PWProjectAccessControl -InputFolder $pwFolder -ImportFilePathName d:\temp\import\projectaccesscontrol.xlsx</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Updates the access control for the specified project, based on the information imported in from the datatable. $dt = Export-PWProjectAccessControl -InputFolder (Get-PWFolders -FolderID 70383 -JustOne) -Verbose Import-PWProjectAccessControl -InputFolder $pwFolder -ImportDatatable $dt -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWProjectForConnectedProjectId --> <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-PWProjectForConnectedProjectId</command:name> <command:verb>Get</command:verb> <command:noun>PWProjectForConnectedProjectId</command:noun> <maml:description> <maml:para>Gets corresponding ProjectWise project object for a given CONNECTED project ID.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: ConnectedProjectId --> <command:syntaxItem> <maml:name>Get-PWProjectForConnectedProjectId</maml:name> <!-- Parameter: ConnectedProjectId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>Array of ProjectWise folders 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ConnectedProjectId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>Array of ProjectWise folders 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</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> <dev:code>$folder = PWProjectForConnectedProjectId 'a5c7db8f-3551-4cfd-964d-eca39a964325' </dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWProjectShareConnection --> <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-PWProjectShareConnection</command:name> <command:verb>Add</command:verb> <command:noun>PWProjectShareConnection</command:noun> <maml:description> <maml:para>Add a Project Share connection to an existing CONNECTED Project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Add-PWProjectShareConnection</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> <!-- Parameter: WSGURL --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>WSGURL</maml:name> <maml:description> <maml:para>WSG URL like https://decide-pwce-us-ws.bentley.com/ws</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WSGVersion --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>WSGVersion</maml:name> <maml:description> <maml:para>WSG Version (default 2.5)</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of connection.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectWiseProjectGUID --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>ProjectWiseProjectGUID</maml:name> <maml:description> <maml:para>Just the Project Guid is adding manually one-by-one.</maml:para> </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="true (ByValue)" position="5"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of connection.</maml:para> </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="6"> <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="7"> <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> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="8"> <maml:name>Token</maml:name> <maml:description> <maml:para>Base 64 Encoded Token string from Get-PWNonFederatedLoginToken -CreateWebToken.</maml: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 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: WSGURL --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>WSGURL</maml:name> <maml:description> <maml:para>WSG URL like https://decide-pwce-us-ws.bentley.com/ws</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WSGVersion --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>WSGVersion</maml:name> <maml:description> <maml:para>WSG Version (default 2.5)</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of connection.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectWiseProjectGUID --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>ProjectWiseProjectGUID</maml:name> <maml:description> <maml:para>Just the Project Guid is adding manually one-by-one.</maml:para> </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="true (ByValue)" position="5"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of connection.</maml:para> </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="6"> <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="7"> <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> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="8"> <maml:name>Token</maml:name> <maml:description> <maml:para>Base 64 Encoded Token string from Get-PWNonFederatedLoginToken -CreateWebToken.</maml: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 ProjectWise folders 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>WSG URL like https://decide-pwce-us-ws.bentley.com/ws</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>WSG Version (default 2.5)</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of connection.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Just the Project Guid is adding manually one-by-one.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Description of connection.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Create new rich projects and add connected projects to them. $rps=Get-PWRichProject -FolderPath 'Projects' foreach ($rp in $rps){ $random = Get-RandomString 10 Add-PWProjectShareConnection $rp -WSGURL 'https://decide-pwce-us-ws.bentley.com/ws' -Name ($rp.Name + '_' + $random) }</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWProjectShareFileFromDisk --> <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-PWProjectShareFileFromDisk</command:name> <command:verb>New</command:verb> <command:noun>PWProjectShareFileFromDisk</command:noun> <maml:description> <maml:para>Upload a file to a folder in the Project Share.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: ProjectShareFolderId --> <command:syntaxItem> <maml:name>New-PWProjectShareFileFromDisk</maml:name> <!-- Parameter: ProjectShareFolderId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ProjectShareFolderId</maml:name> <maml:description> <maml:para>ProjectShare Folder Id</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectedProjectId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>Connected Project to add this file 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: FilePath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Path to 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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <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="4"> <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> <!-- Parameter: WSGVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>WSGVersion</maml:name> <maml:description> <maml:para>defaults to v2.5.</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>v2.5</dev:defaultValue> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="6"> <maml:name>Token</maml:name> <maml:description> <maml:para>Token now 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: ProjectShareFolderId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ProjectShareFolderId</maml:name> <maml:description> <maml:para>ProjectShare Folder Id</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectedProjectId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>Connected Project to add this file 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: FilePath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Path to 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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <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="4"> <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> <!-- Parameter: WSGVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>WSGVersion</maml:name> <maml:description> <maml:para>defaults to v2.5.</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>v2.5</dev:defaultValue> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="6"> <maml:name>Token</maml:name> <maml:description> <maml:para>Token now 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>ProjectShare Folder Id</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Connected Project to add this file to.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Path to file</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$connectedProjectId = Add-PWConnectedProject -ConnectedProjectName '2018-08-29 Germanicus' -ConnectedProjectNumber '2018-08-29-001' -MakeUnique -Industry OilAndGas -AssetType OilRefineries -CountryCode 'ES' -Location 'Madrid' -DataLocation 'North Europe' $shareFolderId = New-PWProjectShareFolder $connectedProjectId -FolderPath "Create a\New Folder\Here" $shareFileId = New-PWProjectShareFileFromDisk $shareFolderId -ConnectedProjectId $connectedProjectId -FilePath "c:\users\user.name\Documents\My Document.docx"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWProjectShareFileFromProjectWise --> <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-PWProjectShareFileFromProjectWise</command:name> <command:verb>New</command:verb> <command:noun>PWProjectShareFileFromProjectWise</command:noun> <maml:description> <maml:para>Upload a ProjectWise document to a folder in the Project Share.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Documents --> <command:syntaxItem> <maml:name>New-PWProjectShareFileFromProjectWise</maml:name> <!-- Parameter: Documents --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Documents</maml:name> <maml:description> <maml:para>ProjectShare Folder Id</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: ProjectShareFolderId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ProjectShareFolderId</maml:name> <maml:description> <maml:para>ProjectShare Folder Id</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectedProjectId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>Connected Project to add this file 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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <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="4"> <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> <!-- Parameter: WSGVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>WSGVersion</maml:name> <maml:description> <maml:para>defaults to v2.5.</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>v2.5</dev:defaultValue> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="6"> <maml:name>Token</maml:name> <maml:description> <maml:para>Token now 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: Documents --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Documents</maml:name> <maml:description> <maml:para>ProjectShare Folder Id</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: ProjectShareFolderId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ProjectShareFolderId</maml:name> <maml:description> <maml:para>ProjectShare Folder Id</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectedProjectId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>Connected Project to add this file 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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <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="4"> <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> <!-- Parameter: WSGVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>WSGVersion</maml:name> <maml:description> <maml:para>defaults to v2.5.</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>v2.5</dev:defaultValue> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="6"> <maml:name>Token</maml:name> <maml:description> <maml:para>Token now 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>PWPS_DAB.CommonTypes+ProjectWiseDocument[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>ProjectShare Folder Id</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>ProjectShare Folder Id</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Connected Project to add this file to.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$connectedProjectId = $connectedProjectId = Add-PWConnectedProject -ConnectedProjectName '2018-08-29 Germanicus' -ConnectedProjectNumber '2018-08-29-001' -MakeUnique -Industry OilAndGas -AssetType OilRefineries -CountryCode 'ES' -Location 'Madrid' -DataLocation 'North Europe' $shareFolderId = New-PWProjectShareFolder $connectedProjectId -FolderPath "Create a\New Folder\Here" $docs = Get-PWDocumentsBySearch -SearchName 'Documents for Upload' New-PWProjectShareFileFromProjectWise $docs -ConnectedProjectId $connectedProjectId -ProjectShareFolderId = $shareFolderId</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWProjectShareFolder --> <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-PWProjectShareFolder</command:name> <command:verb>New</command:verb> <command:noun>PWProjectShareFolder</command:noun> <maml:description> <maml:para>Create a folder path in the Project Share.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: ConnectedProjectId --> <command:syntaxItem> <maml:name>New-PWProjectShareFolder</maml:name> <!-- Parameter: ConnectedProjectId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>Connected Project Id</maml:para> </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="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Backslash delimited 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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Not 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: ConnectedProjectPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Not used.</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: WSGVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>WSGVersion</maml:name> <maml:description> <maml:para>defaults to v2.5.</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>v2.5</dev:defaultValue> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="5"> <maml:name>Token</maml:name> <maml:description> <maml:para>Token now 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: ConnectedProjectId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>Connected Project Id</maml:para> </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="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Backslash delimited 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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>Not 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: ConnectedProjectPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>Not used.</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: WSGVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>WSGVersion</maml:name> <maml:description> <maml:para>defaults to v2.5.</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>v2.5</dev:defaultValue> </command:parameter> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="5"> <maml:name>Token</maml:name> <maml:description> <maml:para>Token now 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>Connected Project Id</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Backslash delimited folder path</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$connectedProjectId = $connectedProjectId = Add-PWConnectedProject -ConnectedProjectName '2018-08-29 Germanicus' -ConnectedProjectNumber '2018-08-29-001' -MakeUnique -Industry OilAndGas -AssetType OilRefineries -CountryCode 'ES' -Location 'Madrid' -DataLocation 'North Europe' $shareFolderId = New-PWProjectShareFolder $connectedProjectId -FolderPath "Create a\New Folder\Here"</dev:code> </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> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> </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> <dev:code>#Example usage getting folders and creating new documents. #Get the folder for folder number 20315 and update contained documents to new project property values Get-PWFolders 20315 | Update-PWPropagateProjectProperties #Get the folder at the given folder path and create a document there Get-PWFolders -FolderPath 'Level 1\Level 2\Level 3\Level | Update-PWPropagateProjectProperties #Update document attributes for a given folder Update-PWPropagateProjectProperties -FolderPath 'PowerShell Demo\Level 2\Level 3\Level 4'</dev:code> </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> <dev:code>#Get the folder for folder number 20315 and update descendant project properties. Get-PWFolders 20315 -JustOne | Update-PWPropagateProjectProperties -Verbose #Get the folders in the tree at the given folder path and working down the tree, update descendant project properties Get-PWFolders -FolderPath 'Level 1\Level 2\Level 3' | Update-PWPropagateProjectProperties -Verbose #Update document attributes for a given folder Get-PWFolders -FolderPath 'Level 1\Level 2\Level 3' -JustOne | Update-PWPropagateProjectProperties -FolderPath 'PowerShell Demo\Level 2\Level 3\Level 4'</dev:code> </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> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Show-PWPS_DABChangeLog</maml:name> <!-- Parameter: ShowAll --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ShowAll</maml:name> <maml:description> <maml:para>Set this switch to display the whole change log.</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: ShowAll --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ShowAll</maml:name> <maml:description> <maml:para>Set this switch to display the whole change log.</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> <dev:code>Show-PWPS_DABChangeLog</dev:code> </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> <dev:code>#use a variable to pass multiple documents. Using a pipe ('|') will cause each document to be processed individually. Ususally not what you want. $documents = Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder' Get-PWReferenceCountReportForDocuments $documents -OutputFilePath c:\temp\References.xlsx </dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Use data table to populate SQL Server Database $cn = new-object System.Data.SqlClient.SqlConnection("Data Source=brumd09515rem;User ID=sa;Password=pwd;Initial Catalog=BulkCopyTest") $cn.Open() $bc = new-object ("System.Data.SqlClient.SqlBulkCopy") $cn $bc.DestinationTableName = "dbo.References_Table" $documents = Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder' $dtable=Get-PWReferenceCountReportForDocuments $documents $bc.WriteToServer($dtable) $cn.Close()</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWReferencedByReportForDocuments --> <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-PWReferencedByReportForDocuments</command:name> <command:verb>Get</command:verb> <command:noun>PWReferencedByReportForDocuments</command:noun> <maml:description> <maml:para>Get XLSX report or SQLite or straight DataTable for all documents referencing the documents passed in pipeline.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>Get-PWReferencedByReportForDocuments</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> <dev:code>#use a variable to pass multiple documents. Using a pipe ('|') will cause each document to be processed individually. Ususally not what you want. $documents = Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder' Get-PWReferencedByReportForDocuments $documents -OutputFilePath c:\temp\ReferencedByReport.xlsx </dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Use data table to populate SQL Server Database $cn = new-object System.Data.SqlClient.SqlConnection("Data Source=brumd09515rem;User ID=sa;Password=pwd;Initial Catalog=BulkCopyTest") $cn.Open() $bc = new-object ("System.Data.SqlClient.SqlBulkCopy") $cn $bc.DestinationTableName = "dbo.ReferencedBy_Table" $documents = Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder' $dtable=Get-PWReferencedByReportForDocuments $documents $bc.WriteToServer($dtable) $cn.Close()</dev:code> </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> <dev:code>#Search for documents and return immediate child documents. Get-PWDocumentsBySearch -SearchName "Documents in Released State" | Get-PWReferenceFiles -ReferenceLevel 0 #Search for documents in folder tree and return all nested references and fill in folder paths and retrieve attributes. Get-PWDocumentsBySearch -FolderPath "Project A\Files to Version" | Get-PWReferenceFiles -GetAttributes</dev:code> </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> <dev:code>#use a variable to pass multiple documents. Using a pipe ('|') will cause each document to be processed individually. Ususally not what you want. $documents = Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder' Get-PWReferenceReportForDocuments $documents -OutputFilePath c:\temp\References.xlsx </dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Use data table to populate SQL Server Database $cn = new-object System.Data.SqlClient.SqlConnection("Data Source=brumd09515rem;User ID=sa;Password=pwd;Initial Catalog=BulkCopyTest") $cn.Open() $bc = new-object ("System.Data.SqlClient.SqlBulkCopy") $cn $bc.DestinationTableName = "dbo.References_Table" $documents = Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder' $dtable=Get-PWReferenceReportForDocuments $documents $bc.WriteToServer($dtable) $cn.Close()</dev:code> </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> <dev:code>Get-PWReferenceReportForFolder -WholeDatasource -OutputFilePath c:\temp\References.xlsx Get-PWReferenceReportForFolder -FolderPath 'Top Level\Project 01' -OutputFilePath c:\temp\References.sqlite #Output DataTable Get-PWReferenceReportForFolder -FolderPath 'Top Level\Project 01'</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Use data table to populate SQL Server Database $cn = new-object System.Data.SqlClient.SqlConnection("Data Source=brumd09515rem;User ID=sa;Password=pwd;Initial Catalog=BulkCopyTest") $cn.Open() $bc = new-object ("System.Data.SqlClient.SqlBulkCopy") $cn $bc.DestinationTableName = "dbo.References_Table" $dtable=Get-PWReferenceReportForFolder -WholeDatasource $bc.WriteToServer($dtable) $cn.Close()</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Request-PWRemoteScriptExecution --> <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>Request-PWRemoteScriptExecution</command:name> <command:verb>Request</command:verb> <command:noun>PWRemoteScriptExecution</command:noun> <maml:description> <maml:para>Request remote script execution. Request listener service required: PWScriptMonitorSvc (https://pwstoragesouthcentralus.blob.core.windows.net/public/PWScriptMonitorSvcSetup.zip).</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: ScriptName --> <command:syntaxItem> <maml:name>Request-PWRemoteScriptExecution</maml:name> <!-- Parameter: ScriptName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ScriptName</maml:name> <maml:description> <maml:para>Script 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: RequesterEmail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RequesterEmail</maml:name> <maml:description> <maml:para>Requester's Email address (remote script may return status).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalParameters --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>AdditionalParameters</maml:name> <maml:description> <maml:para>Additional parameters for script add. Use a hashtable like @{Name = "Name value"; Description = "Description value"}</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: RemoteServerKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>RemoteServerKey</maml:name> <maml:description> <maml:para>Remote server key. Required. Will identify the service which will execute your script. You should make as unique as possible.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceBus --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ServiceBus</maml:name> <maml:description> <maml:para>Service Bus name (optional). 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: Topic --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Topic</maml:name> <maml:description> <maml:para>Topic name (optional). Will be created 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: ServiceBusKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ServiceBusKey</maml:name> <maml:description> <maml:para>Service bus key (optional). Provide it here if you are using your own service bus.</maml: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: ScriptName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ScriptName</maml:name> <maml:description> <maml:para>Script 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: RequesterEmail --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RequesterEmail</maml:name> <maml:description> <maml:para>Requester's Email address (remote script may return status).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AdditionalParameters --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>AdditionalParameters</maml:name> <maml:description> <maml:para>Additional parameters for script add. Use a hashtable like @{Name = "Name value"; Description = "Description value"}</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: RemoteServerKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>RemoteServerKey</maml:name> <maml:description> <maml:para>Remote server key. Required. Will identify the service which will execute your script. You should make as unique as possible.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ServiceBus --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ServiceBus</maml:name> <maml:description> <maml:para>Service Bus name (optional). 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: Topic --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Topic</maml:name> <maml:description> <maml:para>Topic name (optional). Will be created 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: ServiceBusKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ServiceBusKey</maml:name> <maml:description> <maml:para>Service bus key (optional). Provide it here if you are using your own service bus.</maml: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> <dev:code>Request-PWRemoteScriptExecution executeaction.ps1 -RemoteServerKey Server1 Request-PWRemoteScriptExecution test.ps1 -RequesterEmail dave.brumbaugh@bentley.com -AdditionalParameters @{Key1 = "Key1";Key2 = "Key2"} -RemoteServerKey Server1 Request-PWRemoteScriptExecution test.ps1 -RemoteServerKey Server1 -AdditionalParameters @{ datasource="decide-pwce-us.bentley.com:decide-pwce-us-10"; folderpath= 'PDFs with QRCodes'; documentname= "%.pdf"; documentversion= "A"; random= "Some random value"; requesteremail="dave.brumbaugh@bentley.com" }</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWRenditionDestinations --> <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-PWRenditionDestinations</command:name> <command:verb>Get</command:verb> <command:noun>PWRenditionDestinations</command:noun> <maml:description> <maml:para>Get a list of available rendition destinations.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-PWRenditionDestinations returns a list of all available rendintion destinations.</maml:para> </maml:description> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWRenditionDestinations</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWRenditionFileNamingOptions --> <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-PWRenditionFileNamingOptions</command:name> <command:verb>Get</command:verb> <command:noun>PWRenditionFileNamingOptions</command:noun> <maml:description> <maml:para>Get a list of available rendition file naming options.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a list of all rendition profile components file naming options and their values.</maml:para> </maml:description> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for getting a list of rendition file naming options. Get-PWRenditionFileNamingOptions</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWRenditionJobsStatus --> <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-PWRenditionJobsStatus</command:name> <command:verb>Get</command:verb> <command:noun>PWRenditionJobsStatus</command:noun> <maml:description> <maml:para>To be run against Orchestration Framework database to get status of rendition jobs. Returns DataSet object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>To be run against Orchestration Framework database to get status of rendition jobs. Returns DataSet object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWRenditionJobsStatus</maml:name> <!-- Parameter: DatabaseServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>DatabaseServer</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabaseName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabaseUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>DatabaseUser</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabasePwd --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>DatabasePwd</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database password.</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: WhereClause --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>WhereClause</maml:name> <maml:description> <maml:para>Optional WHERE clause for filtering users or datasources from status 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: UseWindowsAuth --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>UseWindowsAuth</maml:name> <maml:description> <maml:para>Switch to use Windows Authentication.</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: DatabaseServer --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>DatabaseServer</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabaseName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>DatabaseName</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabaseUser --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>DatabaseUser</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database 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: DatabasePwd --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>DatabasePwd</maml:name> <maml:description> <maml:para>Orchestration Framework/iCS database password.</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: WhereClause --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="4"> <maml:name>WhereClause</maml:name> <maml:description> <maml:para>Optional WHERE clause for filtering users or datasources from status 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: UseWindowsAuth --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="5"> <maml:name>UseWindowsAuth</maml:name> <maml:description> <maml:para>Switch to use Windows Authentication.</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>Orchestration Framework/iCS database server.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Orchestration Framework/iCS database name.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Orchestration Framework/iCS database user.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Orchestration Framework/iCS database password.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Optional WHERE clause for filtering users or datasources from status report.</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>Switch to use Windows Authentication.</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> <dev:code>Get-PWRenditionJobsStatus -DatabaseServer ServerName -DatabaseName OF -UseWindowsAuth"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWRenditionOptions --> <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-PWRenditionOptions</command:name> <command:verb>Get</command:verb> <command:noun>PWRenditionOptions</command:noun> <maml:description> <maml:para>Get a list of available rendition options.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a list of available rendition options.</maml:para> </maml:description> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for getting a list of rendition options. Get-PWRenditionOptions</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWRenditionPresentationOptions --> <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-PWRenditionPresentationOptions</command:name> <command:verb>Get</command:verb> <command:noun>PWRenditionPresentationOptions</command:noun> <maml:description> <maml:para>Get a list of available rendition presentation options.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a list of available rendition presentation options.</maml:para> </maml:description> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for getting a list of rendition presentation options. Get-PWRenditionPresentationOptions</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWRenditionProfileComponentDestinationDatasource --> <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-PWRenditionProfileComponentDestinationDatasource</command:name> <command:verb>Get</command:verb> <command:noun>PWRenditionProfileComponentDestinationDatasource</command:noun> <maml:description> <maml:para>Get-PWRenditionProfileComponentDestinationDatasource returns the destination datasource name associated with the provided output destination folder name.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-PWRenditionProfileComponentDestinationDatasource returns destination datasource name associated with the provided output destination folder name. To see a list of available output destination folder names, you can issue the cmdlet Get-PWRenditionDestinations. You can also see these with ProjectWise Administrator under Renditions, Rendition Profile Components, Output Destination Folders. If you double click on one of these a dialog will be presented. Of this dialog has an Options tab, the first item should be Datasource: This is what this cmdlet will be returning.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWRenditionProfileComponentDestinationDatasource</maml:name> <!-- Parameter: OutputDestinationFolderName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputDestinationFolderName</maml:name> <maml:description> <maml:para>Output destination folder 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: OutputDestinationFolderName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputDestinationFolderName</maml:name> <maml:description> <maml:para>Output destination folder 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> <dev:code>Returns the destination datasource name associated with "Renditions Folder". Get-PWRenditionProfileComponentDestinationDatasource -OutputDestinationFolderName "Renditions Folder"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWRenditionProfileComponentDestinationDatasource --> <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-PWRenditionProfileComponentDestinationDatasource</command:name> <command:verb>Update</command:verb> <command:noun>PWRenditionProfileComponentDestinationDatasource</command:noun> <maml:description> <maml:para>Update-PWRenditionProfileComponentDestinationDatasource Updates the datasource associated with the provided output destination folder name with the provided value. All output destination folder settings refering to the datasource are also updated.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update-PWRenditionProfileComponentDestinationDatasource Updates the datasource associated with the provided output destination folder name with the provided value. All output destination folder settings refering to the datasource are also updated. These could include the output destination folder and the source distribution folder. To see a list of available output destination folder names, you can issue the cmdlet Get-PWRenditionDestinations. You can also see these with ProjectWise Administrator under Renditions, Rendition Profile Components, Output Destination Folders. If you double-click on one of these, a dialog box will be presented in which you may see a datasource and folder. If these contain datasources, they will be updated with the provided value. If you click on the Source Distribution... button in this dialog box, a dialog will be presented with a destination source folder pattern text item. If that value refers to a datasource, it will be updated with the provided value. An attempt is made to preserve the attribute mapping. This is a major improvement on the Project Administrator functionality. It is assuming that the old destiantion datsource and the updated destination datasource are identical. An attempt is made to deal with fully qualified vs not fully qualified datasource names. The cmdlet returns True if it successfully updates the datasource and all relevant options. False otherwise.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-PWRenditionProfileComponentDestinationDatasource</maml:name> <!-- Parameter: OutputDestinationFolderName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputDestinationFolderName</maml:name> <maml:description> <maml:para>Output destination folder 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> <!-- Parameter: NewDestinationDatasourceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewDestinationDatasourceName</maml:name> <maml:description> <maml:para>New destination datasource name. Preferably this is prefixed with the server name followed by a colon.. 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: OutputDestinationFolderName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputDestinationFolderName</maml:name> <maml:description> <maml:para>Output destination folder 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> <!-- Parameter: NewDestinationDatasourceName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewDestinationDatasourceName</maml:name> <maml:description> <maml:para>New destination datasource name. Preferably this is prefixed with the server name followed by a colon.. 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> <dev:code>Updates the datasource in all relevant "Renditions Folder" settings to "NewServer:NewDatasourceName". Update-PWRenditionProfileComponentDestinationDatasource --OutputDestinationFolderName "Renditions Folder" -DatasourceName "WIN-FUGMJORC1LF:simple"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWRenditionProfileComponentSourceDistributionFolder --> <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-PWRenditionProfileComponentSourceDistributionFolder</command:name> <command:verb>Get</command:verb> <command:noun>PWRenditionProfileComponentSourceDistributionFolder</command:noun> <maml:description> <maml:para>Get-PWRenditionProfileComponentSourceDistributionFolder returns the source distribution folder path associated with the provided output destination folder name.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-PWRenditionProfileComponentSourceDistributionFolder returns the sourcce distribution folder path associated with the provided output destination folder name. To see a list of available output destination folder names, you can issue the cmdlet Get-PWRenditionDestinations. You can also see these with ProjectWise Administrator under Renditions, Rendition Profile Components, Output Destination Folders. If you double click on one of these then click on on the Source Distribution... button, a dialog will be presented with a destination source folder pattern text item. That is the value that this cmdlet is getting.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWRenditionProfileComponentSourceDistributionFolder</maml:name> <!-- Parameter: OutputDestinationFolderName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputDestinationFolderName</maml:name> <maml:description> <maml:para>Output destination folder 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: OutputDestinationFolderName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputDestinationFolderName</maml:name> <maml:description> <maml:para>Output destination folder 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> <dev:code>Returns the output destination source folder path associated with "Renditions Folder". Get-PWRenditionProfileComponentSourceDistributionFolder -OutputDestinationFolderName "Renditions Folder"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWRenditionProfileComponentSourceDistributionFolder --> <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-PWRenditionProfileComponentSourceDistributionFolder</command:name> <command:verb>Update</command:verb> <command:noun>PWRenditionProfileComponentSourceDistributionFolder</command:noun> <maml:description> <maml:para>Update-PWRenditionProfileComponentSourceDistributionFolder Updates the source distribution folder path associated with the provided output destination folder name with the provided value.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update-PWRenditionProfileComponentSourceDistributionFolder Updates the source distribution folder path associated with the provided output destination folder name with the provided value. To see a list of available output destination folder names, you can issue the cmdlet Get-PWRenditionDestinations. You can also see these with ProjectWise Administrator under Renditions, Rendition Profile Components, Output Destination Folders. If you double click on one of these then click on on the Source Distribution... button, a dialog will be presented with a destination source folder pattern text item. That is the value that this cmdlet is updating. Typically the value is a ProjectWise folder path. Returns true if no error occured. False otherwise.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-PWRenditionProfileComponentSourceDistributionFolder</maml:name> <!-- Parameter: OutputDestinationFolderName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputDestinationFolderName</maml:name> <maml:description> <maml:para>Output destination folder 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> <!-- Parameter: NewSourceDistributionFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewSourceDistributionFolder</maml:name> <maml:description> <maml:para>New source distribution folder ProjectWise Path. 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: OutputDestinationFolderName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputDestinationFolderName</maml:name> <maml:description> <maml:para>Output destination folder 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> <!-- Parameter: NewSourceDistributionFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewSourceDistributionFolder</maml:name> <maml:description> <maml:para>New source distribution folder ProjectWise Path. 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> <dev:code>Updates the destination option source folder associated with "Renditions Folder" to "pw://WIN-FUGMJORC1LF:simple/Documents/renditions output/". Update-PWRenditionProfileComponentSourceDistributionFolder -OutputDestinationFolderName "Renditions Folder" -NewSourceDistributionFolder "pw://WIN-FUGMJORC1LF:simple/Documents/renditions output/"</dev:code> </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> <maml:description> <maml:para>Get a list of default options for the profiles.</maml:para> </maml:description> <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> <dev:code>#Example usage for getting a list of default options for all the rendition profiles. Get-PWRenditionProfiles | Get-PWRendtionProfileDefaults</dev:code> </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> <maml:description> <maml:para>Get a list of available profiles.</maml:para> </maml:description> <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> <dev:code>#Example usage for getting a list of rendition profiles. Get-PWRenditionProfiles</dev:code> </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> <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: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> <!-- Parameter: MakeSinglePlotRequest --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>MakeSinglePlotRequest</maml:name> <maml:description> <maml:para>Make one plot request for multiple 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> </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> <!-- Parameter: MakeSinglePlotRequest --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>MakeSinglePlotRequest</maml:name> <maml:description> <maml:para>Make one plot request for multiple 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> </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> <dev:code>#Example usage for creating and submitting a rendition request. #Get documents and submit for plotting. Get-PWDocumentsBySearch -FolderPath "Test 6\Projects 2" -FileName %.dgn -JustThisFolder | New-PWRenditionRequest -ProfileName "For Construction"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWReplicatedStorageAreas --> <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-PWReplicatedStorageAreas</command:name> <command:verb>New</command:verb> <command:noun>PWReplicatedStorageAreas</command:noun> <maml:description> <maml:para>Create dummy storage area for a folder tree, storage area, or whole datasource. Used when recreating a datasource from a database backup.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolders --> <command:syntaxItem> <maml:name>New-PWReplicatedStorageAreas</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: Storages --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Storages</maml:name> <maml:description> <maml:para>Provide a list of storage areas to replicate. Replicates all storage areas by 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> <!-- Parameter: WholeDatasource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>WholeDatasource</maml:name> <maml:description> <maml:para>Replicate storage areas for the 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> <!-- Parameter: UseAdminPaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>UseAdminPaths</maml:name> <maml:description> <maml:para>Used when not being run directly from integration server. You will need admin permissions to the remote server.</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: FileSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>FileSize</maml:name> <maml:description> <maml:para>Will create dummy file of this size (default is 1 byte).</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: 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: Storages --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Storages</maml:name> <maml:description> <maml:para>Provide a list of storage areas to replicate. Replicates all storage areas by 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> <!-- Parameter: WholeDatasource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>WholeDatasource</maml:name> <maml:description> <maml:para>Replicate storage areas for the 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> <!-- Parameter: UseAdminPaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>UseAdminPaths</maml:name> <maml:description> <maml:para>Used when not being run directly from integration server. You will need admin permissions to the remote server.</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: FileSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>FileSize</maml:name> <maml:description> <maml:para>Will create dummy file of this size (default is 1 byte).</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> <dev:code>Get-PWFolders -FolderPath 'Top Level\Sub-Folder' | New-PWReplicatedStorageAreas</dev:code> </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: SkipFolderWorkflowSecurityReplication --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>SkipFolderWorkflowSecurityReplication</maml:name> <maml:description> <maml:para>Skip the Folder + Workflow security replication which can be quite time consuming. Workflow security whould probably be set globally anyway...</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: 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: FolderDepthToCopy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>FolderDepthToCopy</maml:name> <maml:description> <maml:para>Defaults to -1, all folders. 0 will just copy top node, 1 will copy folders one level down, 2 will copy folders two levels down, etc.</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: 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> <!-- Parameter: SkipFolderWorkflowSecurityReplication --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>SkipFolderWorkflowSecurityReplication</maml:name> <maml:description> <maml:para>Skip the Folder + Workflow security replication which can be quite time consuming. Workflow security whould probably be set globally anyway...</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: FolderDepthToCopy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>FolderDepthToCopy</maml:name> <maml:description> <maml:para>Defaults to -1, all folders. 0 will just copy top node, 1 will copy folders one level down, 2 will copy folders two levels down, etc.</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> </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> <dev:code> Example usage for creating a new project from a path New-PWRichProject -NewFolderPath "Test Projects 5\From Script\Project N" -StorageArea Storage1 -TemplateName "Civil Template" -DoNotCopyDocuments -ProjectProperties @{PROJECT_Project_Name='A Project Name'; PROJECT_Project_Number='YYYYY'; PROJECT_Project_Manager_Email='dave.brumbaugh@bentley.com'} #This returns a folder object so you could save it to a variable and use it for additional operations. New-PWRichProject -NewFolderPath "Test Projects 5\From Script\Project N" -UpgradeIfExists -ProjectType "Civil" #This returns a folder object so you could save it to a variable and use it for additional operations. 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'} #Upgrades all folders in datasource starting with "Civil Project..." to rich projects of type "Civil" and sets the project properties.</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Export-PWRichProjectDefinitions --> <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-PWRichProjectDefinitions</command:name> <command:verb>Export</command:verb> <command:noun>PWRichProjectDefinitions</command:noun> <maml:description> <maml:para>Export the PW Rich Project definitions to a spreadsheet. Use with Import-PWRichProjectDefinitions</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: OutputFileName --> <command:syntaxItem> <maml:name>Export-PWRichProjectDefinitions</maml:name> <!-- Parameter: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Spreadsheet for output. Will output an array of DataTables 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: ProjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ProjectTypes</maml:name> <maml:description> <maml:para>Optional list of Project Types. All types will be exported 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: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Spreadsheet for output. Will output an array of DataTables 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: ProjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ProjectTypes</maml:name> <maml:description> <maml:para>Optional list of Project Types. All types will be exported 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>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Spreadsheet for output. Will output an array of DataTables if not provided.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Optional list of Project Types. All types will be exported if not provided.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Export-PWRichProjectDefinitions c:\temp\RichProjectDefs.xlsx -ProjectTypes "General","Civil","Geospatial"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-PWRichProjectDefinitions --> <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-PWRichProjectDefinitions</command:name> <command:verb>Import</command:verb> <command:noun>PWRichProjectDefinitions</command:noun> <maml:description> <maml:para>Export the PW Rich Project definitions to a spreadsheet. Use with Import-PWRichProjectDefinitions.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>(Not yet adding new properties to exising project types correctly. New project types seem to work fine.)</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFileName --> <command:syntaxItem> <maml:name>Import-PWRichProjectDefinitions</maml:name> <!-- Parameter: InputFileName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFileName</maml:name> <maml:description> <maml:para>Spreadsheet for output. Will output an array of DataTables 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: ProjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ProjectTypes</maml:name> <maml:description> <maml:para>Optional list of Project Types to import from spreadsheet. All types will be imported 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: InputFileName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFileName</maml:name> <maml:description> <maml:para>Spreadsheet for output. Will output an array of DataTables 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: ProjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ProjectTypes</maml:name> <maml:description> <maml:para>Optional list of Project Types to import from spreadsheet. All types will be imported 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>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Spreadsheet for output. Will output an array of DataTables if not provided.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Optional list of Project Types to import from spreadsheet. All types will be imported if not provided.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Export-PWRichProjectDefinitions c:\temp\RichProjectDefs.xlsx -ProjectTypes "General","Civil","Geospatial"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWRichProjectFromTemplate --> <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-PWRichProjectFromTemplate</command:name> <command:verb>New</command:verb> <command:noun>PWRichProjectFromTemplate</command:noun> <maml:description> <maml:para>Creates a new rich project / work area from a template project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Accepts a folder object from the pipeline or a project path including the new project name.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>New-PWRichProjectFromTemplate</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 to create new Rich Project / Work Area in. Requires the new project name to be included in the NewProjectName parameter.</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: NewProjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewProjectName</maml:name> <maml:description> <maml:para>Name of new Rich Project / Work 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: TemplateName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>TemplateName</maml:name> <maml:description> <maml:para>Name of Template project to be used for new Rich Project / Work 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: StorageArea --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>StorageArea</maml:name> <maml:description> <maml:para>Storage area name to be used when creating new Rich Project / Work Area. Required. Error if not found. Only the project folder will use this storage area unless the UpdateAllStorageAreas switch parameter is included.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DoNotCopyDocuments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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: NewProjectDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewProjectDescription</maml:name> <maml:description> <maml:para>Project description for new Rich Project / Work 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: UpdateAllStorageAreas --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateAllStorageAreas</maml:name> <maml:description> <maml:para>When included, will use the provided storage area for ALL folders in the new Rich Project / Work Area.</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> <!-- Parameter set: NewFolderPath --> <command:syntaxItem> <maml:name>New-PWRichProjectFromTemplate</maml:name> <!-- Parameter: NewFolderPathName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NewFolderPathName</maml:name> <maml:description> <maml:para>Full folder path and name of new Rich Project / Work Area 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: NewProjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewProjectName</maml:name> <maml:description> <maml:para>Name of new Rich Project / Work 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: TemplateName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>TemplateName</maml:name> <maml:description> <maml:para>Name of Template project to be used for new Rich Project / Work 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: StorageArea --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>StorageArea</maml:name> <maml:description> <maml:para>Storage area name to be used when creating new Rich Project / Work Area. Required. Error if not found. Only the project folder will use this storage area unless the UpdateAllStorageAreas switch parameter is included.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DoNotCopyDocuments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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: NewProjectDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewProjectDescription</maml:name> <maml:description> <maml:para>Project description for new Rich Project / Work 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: UpdateAllStorageAreas --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateAllStorageAreas</maml:name> <maml:description> <maml:para>When included, will use the provided storage area for ALL folders in the new Rich Project / Work Area.</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="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Folder object from pipeline to create new Rich Project / Work Area in. Requires the new project name to be included in the NewProjectName parameter.</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: NewProjectName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>NewProjectName</maml:name> <maml:description> <maml:para>Name of new Rich Project / Work 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: NewFolderPathName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>NewFolderPathName</maml:name> <maml:description> <maml:para>Full folder path and name of new Rich Project / Work Area 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: NewProjectDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewProjectDescription</maml:name> <maml:description> <maml:para>Project description for new Rich Project / Work 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: TemplateName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>TemplateName</maml:name> <maml:description> <maml:para>Name of Template project to be used for new Rich Project / Work 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: StorageArea --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>StorageArea</maml:name> <maml:description> <maml:para>Storage area name to be used when creating new Rich Project / Work Area. Required. Error if not found. Only the project folder will use this storage area unless the UpdateAllStorageAreas switch parameter is included.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UpdateAllStorageAreas --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UpdateAllStorageAreas</maml:name> <maml:description> <maml:para>When included, will use the provided storage area for ALL folders in the new Rich Project / Work Area.</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: DoNotCopyDocuments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <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> </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 to create new Rich Project / Work Area in. Requires the new project name to be included in the NewProjectName parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Example usage for creating a new project from a folder object with the option to NOT copy documents. Returns a folder object for the new project created. New-PWRichProjectFromTemplate -InputFolder (Get-PWFolders -FolderPath 'PowerShell' -NewProjectName 'MyNewProject' -TemplateName "Civil Template" -StorageArea 'Storage_01' -DoNotCopyDocuments -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Example usage for creating a new project from a folder path and name. Also, includes an optional description, and the option to update the storage area for all sub-folders. Returns a folder object for the new project created. New-PWRichProject -NewFolderPathName "PowerShell\MyNewProject" -NewProjectDescription 'My New Project' -TemplateName "Civil Template" -StorageArea 'Storage_01' -UpdateAllStorageAreas -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWRichProjectMaxUpdateDate --> <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-PWRichProjectMaxUpdateDate</command:name> <command:verb>Get</command:verb> <command:noun>PWRichProjectMaxUpdateDate</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWRichProjectMaxUpdateDate</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="true (ByValue)" 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> </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="true (ByValue)" 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> </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: Get-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>Get-PWRichProjectProperties</command:name> <command:verb>Get</command:verb> <command:noun>PWRichProjectProperties</command:noun> <maml:description> <maml:para>Get the list of available project properties in the datasource in order to specify in view definition.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> </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> <dev:code>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'} 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'}</dev:code> </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> <dev:code>#Output a spreadsheet with the rich project data Get-PWRichProjectReport -FolderPath 'Top Level\Sub-Folder' -OutputFileName c:\temp\RichProjects.xlsx #Output a array of datatables with the rich project data $dts = Get-PWRichProjectReport -FolderPath 'Top Level\Sub-Folder' -OutputDataTables</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-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>Remove-PWRichProjectResource</command:name> <command:verb>Remove</command:verb> <command:noun>PWRichProjectResource</command:noun> <maml:description> <maml:para>Remove-PWRichProjectResource removes a specific resource member from a resource type associated with a Work Area / Rich Project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove-PWRichProjectResource removes a specific resource member from a resource type associated with a Work Area / Rich Project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Remove-PWRichProjectResource</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Source Work Area / Rich Project folder to copy resource data from.</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: ResourceType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Specifies the resource type containing the resource member.</maml:para> </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="2"> <maml:name>ResourceMemberName</maml:name> <maml:description> <maml:para>Specifies the name of the resource to be removed. 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> </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>Source Work Area / Rich Project folder to copy resource data from.</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: ResourceType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Specifies the resource type containing the resource member.</maml:para> </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="2"> <maml:name>ResourceMemberName</maml:name> <maml:description> <maml:para>Specifies the name of the resource to be removed. 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Source Work Area / Rich Project folder to copy resource data from.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Removes the specified resource member of resource type.. Remove-PWRichProjectResource -InputFolder (Show-PWFolderBrowserDialog) -ResourceType 'application' -ResourceMemberName 'Microstation' -Verbose</dev:code> </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: InputFolder --> <command:syntaxItem> <maml:name>Set-PWRichProjectResource</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: 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="false" 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:syntaxItem> <!-- Parameter set: FolderPath --> <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: 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="false" 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: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: 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="false" 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>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: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> <dev:code>#Example usage for setting a project's application resource to inherit. Set-PWRichProjectResource -FolderPath 'Projects' -ResourceType 'application' -Inherit #Example usage for setting a project's workspace profiles resource to none. Set-PWRichProjectResource -FolderPath 'Projects' -ResourceType 'workspaceprofile' -None #Example usage for adding the MicroStation application to the project's application resources. Set-PWRichProjectResource -FolderPath 'Projects' -ResourceType 'application' -ResourceMemberName 'Microstation'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Copy-PWRichProjectResources --> <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-PWRichProjectResources</command:name> <command:verb>Copy</command:verb> <command:noun>PWRichProjectResources</command:noun> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Copy-PWRichProjectResources</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Source Work Area / Rich Project folder to copy resource data from.</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="true" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Specifies the Work Area / Rich Project folder to copy resource data 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: ResourceType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Specifies the resource type to copy.</maml:para> </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="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ResourceMemberName</maml:name> <maml:description> <maml:para>Specifies the name of the resource to copy. 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> </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>Source Work Area / Rich Project folder to copy resource data from.</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="true" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Specifies the Work Area / Rich Project folder to copy resource data 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: ResourceType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Specifies the resource type to copy.</maml:para> </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="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ResourceMemberName</maml:name> <maml:description> <maml:para>Specifies the name of the resource to copy. 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Source Work Area / Rich Project folder to copy resource data from.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-PWRichProjectResources --> <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-PWRichProjectResources</command:name> <command:verb>Get</command:verb> <command:noun>PWRichProjectResources</command:noun> </command:details> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWRichProjectResources</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Work Area / Rich Project folder object to get resource information for. Requires the new project name to be included in the NewProjectName parameter.</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: ResourceType --> <command:parameter required="false" 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> </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>Work Area / Rich Project folder object to get resource information for. Requires the new project name to be included in the NewProjectName parameter.</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: ResourceType --> <command:parameter required="false" 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWPS_DAB.CommonTypes+ProjectWiseFolder</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Work Area / Rich Project folder object to get resource information for. Requires the new project name to be included in the NewProjectName parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </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: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> <maml:description> <maml:para>Get-PWRichProjects returns ProjectWise Folder Objects for all of the Work Areas/Rich Projects within current datasource or the specified folder path or matching the type and sample property values.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-PWRichProjects returns all of the Work Areas/Rich Projects within current datasource or the specified folder path.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: FolderPath --> <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> <maml:description> <maml:para>Search for Rich Projects in this tree.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectTypeName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ProjectTypeName</maml:name> <maml:description> <maml:para>Project Type Name to search for (Required to do Properties 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: PopulateProjectProperties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>PopulateProjectProperties</maml:name> <maml:description> <maml:para>Set to get Project Properties on folder object populated.</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: JustOne --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>JustOne</maml:name> <maml:description> <maml:para>Just return project specified by path.</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: ProjectProperties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ProjectProperties</maml:name> <maml:description> <maml:para>List of project property values to search for (e.g. @{PROJECT_Project_Name='A Project Name'; PROJECT_Project_Number='YYYYY'}. Property names are case sensitive. % supported as wild card on strings.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Collections.Hashtable</dev:defaultValue> </command:parameter> <!-- Parameter: PopulatePaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>PopulatePaths</maml:name> <maml:description> <maml:para>Fill in the folder paths.</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: FolderName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>FolderName</maml:name> <maml:description> <maml:para>OBSOLETE. Ignored.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BypassSearchAssembly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>BypassSearchAssembly</maml:name> <maml:description> <maml:para>OBSOLETE. Ignored.</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: OnlyConnectedProjects --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>OnlyConnectedProjects</maml:name> <maml:description> <maml:para>Set to return only connected projects.</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: OnlyNonConnectedProjects --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>OnlyNonConnectedProjects</maml:name> <maml:description> <maml:para>Set to return only the projects that are not connected projects.</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>Search for Rich Projects in this tree.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectTypeName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ProjectTypeName</maml:name> <maml:description> <maml:para>Project Type Name to search for (Required to do Properties 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: PopulateProjectProperties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>PopulateProjectProperties</maml:name> <maml:description> <maml:para>Set to get Project Properties on folder object populated.</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: JustOne --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>JustOne</maml:name> <maml:description> <maml:para>Just return project specified by path.</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: ProjectProperties --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ProjectProperties</maml:name> <maml:description> <maml:para>List of project property values to search for (e.g. @{PROJECT_Project_Name='A Project Name'; PROJECT_Project_Number='YYYYY'}. Property names are case sensitive. % supported as wild card on strings.</maml:para> </maml:description> <command:parameterValue required="true">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.Collections.Hashtable</dev:defaultValue> </command:parameter> <!-- Parameter: FolderName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>FolderName</maml:name> <maml:description> <maml:para>OBSOLETE. Ignored.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BypassSearchAssembly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>BypassSearchAssembly</maml:name> <maml:description> <maml:para>OBSOLETE. Ignored.</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: PopulatePaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>PopulatePaths</maml:name> <maml:description> <maml:para>Fill in the folder paths.</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: OnlyConnectedProjects --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>OnlyConnectedProjects</maml:name> <maml:description> <maml:para>Set to return only connected projects.</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: OnlyNonConnectedProjects --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>OnlyNonConnectedProjects</maml:name> <maml:description> <maml:para>Set to return only the projects that are not connected projects.</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> <dev:code>#Example usage returning Work Areas/Rich Projects. The following will return all Work Areas/Rich Projects within the current ProjectWise Datasource. Get-PWRichProjects -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#The following will return all Work Areas/Rich Projects within the folder path $rps = Get-PWRichProjects -FolderPath 'BSI900 - Adelaide Tower' -PopulatePaths #The following will return all Work Areas/Rich Projects within the folder path of the given Project Type and will populate the project properties in the returned object. $rps1 = Get-PWRichProjects -FolderPath 'Test Rich Connected Projects' -ProjectTypeName 'AllColumnTypes' -PopulateProjectProperties #The following will return all Work Areas/Rich Projects of the given Project Type matching the given property values. Property names are case-sensitive. $rps2 = Get-PWRichProjects -ProjectTypeName 'AllColumnTypes' -ProjectProperties @{PROJECT_P_STRING = "Some new string"; PROJECT_P_LONGINTEGER = 555} -PopulateProjectProperties #The following will return all Work Areas/Rich Projects of the given Project Type and populate the project properties on the returned objects. $rps3 = Get-PWRichProjects -ProjectTypeName 'General' -PopulateProjectProperties</dev:code> </command:example> </command:examples> </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> <!-- Parameter: SkipFolderWorkflowSecurityReplication --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>SkipFolderWorkflowSecurityReplication</maml:name> <maml:description> <maml:para>Skip the Folder + Workflow security replication which can be quite time consuming. Workflow security whould probably be set globally anyway...</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: FolderDepthToCopy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>FolderDepthToCopy</maml:name> <maml:description> <maml:para>Defaults to -1, all folders. 0 will just copy top node, 1 will copy folders one level down, 2 will copy folders two levels down, etc.</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> </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> <!-- Parameter: SkipFolderWorkflowSecurityReplication --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>SkipFolderWorkflowSecurityReplication</maml:name> <maml:description> <maml:para>Skip the Folder + Workflow security replication which can be quite time consuming. Workflow security whould probably be set globally anyway...</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: FolderDepthToCopy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>FolderDepthToCopy</maml:name> <maml:description> <maml:para>Defaults to -1, all folders. 0 will just copy top node, 1 will copy folders one level down, 2 will copy folders two levels down, etc.</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> </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> <dev:code>#Create rich projects from an array of DataTables New-PWRichProjectsFromDataTables -Data $dts -DefaultNewParentPath 'New Projects\Create here' -DefaultTemplateName 'General' -DefaultStorageArea Stor01</dev:code> </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> <dev:code>#Update rich projects from an array of datatables Update-PWRichProjectsFromDataTables $dts</dev:code> </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> <!-- Parameter: ProjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ProjectTypes</maml:name> <maml:description> <maml:para>If included, will only process the Project Types in the list (corresponds to Worksheet 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: SkipFolderWorkflowSecurityReplication --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>SkipFolderWorkflowSecurityReplication</maml:name> <maml:description> <maml:para>Skip the Folder + Workflow security replication which can be quite time consuming. Workflow security whould probably be set globally anyway...</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: FolderDepthToCopy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>FolderDepthToCopy</maml:name> <maml:description> <maml:para>Defaults to -1, all folders. 0 will just copy top node, 1 will copy folders one level down, 2 will copy folders two levels down, etc.</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> </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> <!-- Parameter: ProjectTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ProjectTypes</maml:name> <maml:description> <maml:para>If included, will only process the Project Types in the list (corresponds to Worksheet 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: SkipFolderWorkflowSecurityReplication --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>SkipFolderWorkflowSecurityReplication</maml:name> <maml:description> <maml:para>Skip the Folder + Workflow security replication which can be quite time consuming. Workflow security whould probably be set globally anyway...</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: FolderDepthToCopy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>FolderDepthToCopy</maml:name> <maml:description> <maml:para>Defaults to -1, all folders. 0 will just copy top node, 1 will copy folders one level down, 2 will copy folders two levels down, etc.</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> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Create rich projects from a spreadsheet New-PWRichProjectsFromSpreadsheet -InputFileName c:\temp\RichProjects01.xlsx -DefaultNewParentPath 'New Projects\Create here' -DefaultTemplateName 'General' -DefaultStorageArea Stor01 #Create rich projects from a spreadsheet (subset of projects) New-PWRichProjectsFromSpreadsheet -InputFileName c:\temp\RichProjects01.xlsx -DefaultNewParentPath 'New Projects\Create here' -DefaultTemplateName 'General' -DefaultStorageArea Stor01 -ProjectTypes "Civil","General"</dev:code> </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> <!-- Parameter: WorksheetName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>WorksheetName</maml:name> <maml:description> <maml:para>Worksheet to use (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: 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: WorksheetName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>WorksheetName</maml:name> <maml:description> <maml:para>Worksheet to use (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> <dev:code>#Update rich project properties from a spreadsheet Update-PWRichProjectsFromSpreadsheet -InputFileName c:\temp\RichProjects01.xlsx</dev:code> </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 (WorkArea) and sub-Rich Projects to folders.</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: InputFolder --> <command:syntaxItem> <maml:name>Convert-PWRichProjectToFolder</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>ProjectWise folder object to downgrade to a folder.</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: DowngradeSubProjects --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DowngradeSubProjects</maml:name> <maml:description> <maml:para>When included, all sub-projects (workarea) will be downgraded.</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> <!-- Parameter set: FolderPath --> <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 rich project (workarea) to downgrade to a 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: DowngradeSubProjects --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DowngradeSubProjects</maml:name> <maml:description> <maml:para>When included, all sub-projects (workarea) will be downgraded.</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="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>ProjectWise folder object to downgrade to a folder.</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="true" globbing="false" pipelineInput="false" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Full folder path of rich project (workarea) to downgrade to a 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: DowngradeSubProjects --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DowngradeSubProjects</maml:name> <maml:description> <maml:para>When included, all sub-projects (workarea) will be downgraded.</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>ProjectWise folder object to downgrade to a folder.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Example usage for converting a Rich Project (WorkArea) to a folder. Convert-PWRichProjectToFolder -InputFolder (Show-PWFolderBrowserDialog) -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Example usage for converting a Rich Project (WorkArea) and all sub-RichProjects to folders. Convert-PWRichProjectToFolder -FolderPath "MyRichProject" -DowngradeSubProjects -Verbose</dev:code> </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> <dev:code>#Example usage for getting all of the Rich Project Types. Get-PWRichProjectTypes #Example usage for getting specific Rich Project Types Get-PWRichProjectTypes | Where-Object {$_.SystemClass -eq "1" -and $_.ClassDesc -ne "PickLists"}</dev:code> </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: OwnerProject --> <command:syntaxItem> <maml:name>Add-PWSavedSearch</maml:name> <!-- Parameter: OwnerProject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>OwnerProject</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: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Workflow 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: States --> <command:parameter required="false" globbing="false" pipelineInput="false" position="15"> <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="16"> <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>01/01/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: UpdatedBefore --> <command:parameter required="false" globbing="false" pipelineInput="false" position="17"> <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>01/01/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: ViewName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="18"> <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: ReplaceExisting --> <command:parameter required="false" globbing="false" pipelineInput="false" position="19"> <maml:name>ReplaceExisting</maml:name> <maml:description> <maml:para>Does not overwrite existing search by default.</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: 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: WholeDatasource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="20"> <maml:name>WholeDatasource</maml:name> <maml:description> <maml:para>Force a whole datasource search even when search belongs to a project.</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: 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: OwnerProject --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>OwnerProject</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: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Workflow 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: States --> <command:parameter required="false" globbing="false" pipelineInput="false" position="15"> <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="16"> <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>01/01/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: UpdatedBefore --> <command:parameter required="false" globbing="false" pipelineInput="false" position="17"> <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>01/01/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: ViewName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="18"> <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: ReplaceExisting --> <command:parameter required="false" globbing="false" pipelineInput="false" position="19"> <maml:name>ReplaceExisting</maml:name> <maml:description> <maml:para>Does not overwrite existing search by default.</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: WholeDatasource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="20"> <maml:name>WholeDatasource</maml:name> <maml:description> <maml:para>Force a whole datasource search even when search belongs to a project.</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> <dev:code>#Create a search in each rich project Get-PWRichProjects | Add-PWSavedSearch -SearchName 'Search Folder\PDF Search made by PowerShell' -SearchSubFolders -FileName %.pdf -Verbose #Create a search with attributes and states Get-PWFolders -FolderPath 'Top Level\Project 01' -JustOne | Add-PWSavedSearch -SearchName 'My Searches\Attribute Search' -SearchFolder 'Top Level\Project 01\PDFs' -SearchSubFolders -FileName %.pdf -Attributes @{DWG_No = "A-7%"; Title = "Detail%" } -States "Draft","Pending Approval" -Verbose #Create a search with dates Get-PWFolders -FolderPath 'Top Level\Project 01' -JustOne | Add-PWSavedSearch -SearchName 'Current Documents\Updated PDFs' -SearchFolder 'Top Level\Project 01\PDFs' -SearchSubFolders -FileName %.pdf -UpdatedAfter 10/11/2017 -Verbose #Create a global search Add-PWSavedSearch -SearchName 'My global searches\Search Tree\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</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Copy-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>Copy-PWSavedSearch</command:name> <command:verb>Copy</command:verb> <command:noun>PWSavedSearch</command:noun> <maml:description> <maml:para>Copy a saved search to the datasource or to a Work Area.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Copy a saved search to the datasource or to a Work Area. Defaults to global saved search unless a target folder is included.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: FolderPath --> <command:syntaxItem> <maml:name>Copy-PWSavedSearch</maml:name> <!-- Parameter: SavedSearch --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SavedSearch</maml:name> <maml:description> <maml:para>Name of saved search to copy.</maml:para> </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 of Work Area 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: FolderPath_Target --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FolderPath_Target</maml:name> <maml:description> <maml:para>Folder path to copy saved search 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: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Set this to copy the current user's saved 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> <!-- Parameter set: FolderID --> <command:syntaxItem> <maml:name>Copy-PWSavedSearch</maml:name> <!-- Parameter: SavedSearch --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SavedSearch</maml:name> <maml:description> <maml:para>Name of saved search to copy.</maml:para> </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>Folder ID of Work Area to search for saved searches.</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_Target --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FolderPath_Target</maml:name> <maml:description> <maml:para>Folder path to copy saved search 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: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Set this to copy the current user's saved 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: SavedSearch --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SavedSearch</maml:name> <maml:description> <maml:para>Name of saved search to copy.</maml:para> </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 of Work Area 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: FolderID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FolderID</maml:name> <maml:description> <maml:para>Folder ID of Work Area to search for saved searches.</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_Target --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FolderPath_Target</maml:name> <maml:description> <maml:para>Folder path to copy saved search 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: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Personal</maml:name> <maml:description> <maml:para>Set this to copy the current user's saved 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> <dev:code>#Copies the 'TEST' saved search from Work Area (specified by FolderID 177) to the Personal saved searches in Work Area 'BSI200 - Peterborough Geospatial Investigation'. Copy-PWSavedSearches -SavedSearch 'TEST' -FolderID 177 -FolderPath_Target 'BSI200 - Peterborough Geospatial Investigation' -Personal -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Copies the 'AllDocs' saved search from Work Area 'BSI900 - Adelaide Tower' to the Global saved searches in Work Area 'BSI200 - Peterborough Geospatial Investigation'. Copy-PWSavedSearches -SavedSearch 'AllDocs' -FolderPath 'BSI900 - Adelaide Tower' -FolderPath_Target 'BSI200 - Peterborough Geospatial Investigation' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>#Copies the 'TEST' saved search from Work Area (specified by FolderID 177) to the Personal saved searches at the database level. Copy-PWSavedSearches -SavedSearch 'TEST' -FolderID 177 -Personal -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>#Copies the 'AllDocs' saved search from Work Area 'BSI900 - Adelaide Tower' to the Global saved searches at the datasource level. Copy-PWSavedSearches -SavedSearch 'AllDocs' -FolderPath 'BSI900 - Adelaide Tower' -Verbose</dev:code> </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> <dev:code>#Delete searches that start with "Delete Me" Remove-PWSavedSearch -SearchName "Delete Me*" -Verbose #Get all rich projects in the given tree and remove their saved searches Get-PWRichProjects -FolderPath "Project Parent\EADOC" | Remove-PWSavedSearch #Delete searches belonging to users Dave and Bryan Remove-PWSavedSearch -UserName Dave,Bryan</dev:code> </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> <dev:code>#Example usage getting list of global saved searches within the current datasource. #Get the global saved searches within the current datasource. Get-PWSavedSearches #Get the global saved searches within the given folder. Get-PWSavedSearches -FolderPath 'Top Leve\Sub Level\Sub Level2' #Get the current user's saved searches within the given folder. Get-PWSavedSearches -FolderPath 'Top Leve\Sub Level\Sub Level2' -Personal #Get the current user's saved searches at the top level of the datasource. Get-PWSavedSearches -Personal #Get the current user's saved searches for all the projects in the given path. Get-PWRichProjects -FolderPath 'Top Level\Projects' | Get-PWSavedSearches -Personal</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWSavedSearchOrGroup --> <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-PWSavedSearchOrGroup</command:name> <command:verb>Add</command:verb> <command:noun>PWSavedSearchOrGroup</command:noun> <maml:description> <maml:para>Add an OR group (page) to existing saved search.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: SearchName --> <command:syntaxItem> <maml:name>Add-PWSavedSearchOrGroup</maml:name> <!-- Parameter: SearchName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SearchName</maml:name> <maml:description> <maml:para>Search name to add Or Group 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: 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: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Workflow 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: States --> <command:parameter required="false" globbing="false" pipelineInput="false" position="15"> <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="16"> <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>01/01/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: UpdatedBefore --> <command:parameter required="false" globbing="false" pipelineInput="false" position="17"> <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>01/01/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="18"> <maml:name>Personal</maml:name> <maml:description> <maml:para>If this 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> <!-- 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: WholeDatasource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="20"> <maml:name>WholeDatasource</maml:name> <maml:description> <maml:para>Force a whole datasource search even when search belongs to a project.</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: 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: SearchName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SearchName</maml:name> <maml:description> <maml:para>Search name to add Or Group 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: 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: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Workflow 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: States --> <command:parameter required="false" globbing="false" pipelineInput="false" position="15"> <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="16"> <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>01/01/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: UpdatedBefore --> <command:parameter required="false" globbing="false" pipelineInput="false" position="17"> <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>01/01/0001 12:00:00 AM</dev:defaultValue> </command:parameter> <!-- Parameter: Personal --> <command:parameter required="false" globbing="false" pipelineInput="false" position="18"> <maml:name>Personal</maml:name> <maml:description> <maml:para>If this 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> <!-- Parameter: WholeDatasource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="20"> <maml:name>WholeDatasource</maml:name> <maml:description> <maml:para>Force a whole datasource search even when search belongs to a project.</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> <dev:code>Add-PWSavedSearchOrGroup 'My global searches\Search Tree\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</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWSession --> <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-PWSession</command:name> <command:verb>Set</command:verb> <command:noun>PWSession</command:noun> <maml:description> <maml:para>Set active session.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Datasource --> <command:syntaxItem> <maml:name>Set-PWSession</maml:name> <!-- Parameter: Datasource --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Datasource</maml:name> <maml:description> <maml:para>Datasource to change 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: Datasource --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Datasource</maml:name> <maml:description> <maml:para>Datasource to change 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>Datasource to change to (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWSessions</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWSessions --> <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-PWSessions</command:name> <command:verb>Get</command:verb> <command:noun>PWSessions</command:noun> <maml:description> <maml:para>Get active sessions.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWSessions</dev:code> </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> <maml:description> <maml:para>Run a select statement against the database and return the results to a spreadsheet or SQLite database in addition to DataTable object.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: SQLSelectStatement --> <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> </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> </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> <dev:code>Select-PWSQL 'select * from t_lookup_tmc' -OutputFileName 'c:\temp\t_lookup_tmc.sqlite' #When running a stored procedure (not recommended) include SET NOCOUNT ON in the procedure source to keep from raising an error. Select-PWSQL 'EXEC SP_Not_A_Dangeous_Procedure'</dev:code> </command:example> </command:examples> </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">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</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">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: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> <maml:description> <maml:para>Run a select statement against the database and extract the results to a data table object.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: SQLSelectStatement --> <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:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$dt=Select-PWSQLDataTable 'select * from t_lookup_tmc' New-XLSXWorkbook $dt -OutputFileName c:\temp\t_lookup_tmc.xlsx' #When running a stored procedure (not recommended) include SET NOCOUNT ON in the procedure source to keep from raising an error. Select-PWSQLDataTable 'EXEC SP_Not_A_Dangeous_Procedure'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Select-PWSQLDataTableToSQLite --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Select-PWSQLDataTableToSQLite</command:name> <command:verb>Select</command:verb> <command:noun>PWSQLDataTableToSQLite</command:noun> <maml:description> <maml:para>Pass in a SQL Select statement and have the output returned as a table in a new SQLite database. Can be used to debug output from SQL Select statement.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If using the Bulk Import features of SQL Server, it's important to make sure the columns match up. This is an easy way to debug the data before trying to do a bulk insert.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Select-PWSQLDataTableToSQLite</maml:name> <!-- Parameter: SQLSelectStatement --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SQLSelectStatement</maml:name> <maml:description> <maml:para>SQL Select statement to execute (Required).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SQLiteFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SQLiteFolder</maml:name> <maml:description> <maml:para>Folder to write SQLite database to. Omit if database is not required.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SQLSelectStatement --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SQLSelectStatement</maml:name> <maml:description> <maml:para>SQL Select statement to execute (Required).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SQLiteFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SQLiteFolder</maml:name> <maml:description> <maml:para>Folder to write SQLite database to. Omit if database is not required.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: DataTable --> <command:returnValue> <dev:type> <maml:name>System.Data.DataTable</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Select-PWSQLDataTableToSQLite -SQLiteFolder c:\dboutput\</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWStandardViewColumns --> <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-PWStandardViewColumns</command:name> <command:verb>Get</command:verb> <command:noun>PWStandardViewColumns</command:noun> <maml:description> <maml:para>Get the list of available standard view columns.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> </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> <dev:code>#Example usage for New-PWState. #Will return a state object for the new state in the current datasource. New-PWState -Name 'Review' -Description 'Reveiw State'</dev:code> </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> <dev:code>#Example usage for Remove-PWState. #Will return "true" if the state is successfully removed from the current datasource. Remove-PWState -StateName 'Approved'</dev:code> </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> <dev:code>#Example usage for Get-PWStates. #Will return all state objects from current datasource. Get-PWStates</dev:code> </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> <dev:code>#Get all datasource statistics Get-PWStatistics -ForceRefresh -IgnoreLastLoginCount</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-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>Update-PWStatistics</command:name> <command:verb>Update</command:verb> <command:noun>PWStatistics</command:noun> <maml:description> <maml:para>Updates the statistics for the 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> <dev:code>Updates the current datasource statistics Update-PWStatistics</dev:code> </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> <dev:code>New-PWStorageArea -Name "New Storage" -HostName MachineName -Path "c:\pwstore\New Storage" -Description "New Storage Description"</dev:code> </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> <maml:description> <maml:para>The Update-PWStorageAreaForProjectTree cmdlet updates the storage area of the provided folder path and all of its sub-folders.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If the JustOne parameter is included, only the provided folder willbe updated.</maml:para> </maml:description> <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: SourceStorageArea --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>SourceStorageArea</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeleteFromSourceStorage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeleteFromSourceStorage</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: SkipStorageAreaMatchCheck --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipStorageAreaMatchCheck</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: DeleteFromSourceStorage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeleteFromSourceStorage</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> <!-- Parameter: SkipStorageAreaMatchCheck --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipStorageAreaMatchCheck</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: SourceStorageArea --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>SourceStorageArea</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> <dev:code>The following will update the storage area for the specified folder and all sub-folders. $Splat_UpdateStorageArea = @{ FolderPath = "Projects\MyProject" NewStorageArea = "NewStorageArea" SourceStorageArea = "OldStorageArea" } Update-PWStorageAreaForProjectTree @Splat_UpdateStorageArea -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>The following will update just the specified folder. Update-PWStorageAreaForProjectTree @Splat_UpdateStorageArea -JustOne -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>The following will use the admin paths and ONLY update the specified folder. Update-PWStorageAreaForProjectTree @Splat_UpdateStorageArea -UseAdminPaths -JustOne -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>The following will use update specified folder and all sub-folders. Deletes the folders from the source storage area. Update-PWStorageAreaForProjectTree @Splat_UpdateStorageArea -DeleteFromSourceStorage -Verbose</dev:code> </command:example> </command:examples> </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> <dev:code>Get-PWStorageAreaList -StorageAreaNames "Storage 1","Storage 2","Project Office"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWStorageAreaProperties --> <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-PWStorageAreaProperties</command:name> <command:verb>Update</command:verb> <command:noun>PWStorageAreaProperties</command:noun> <maml:description> <maml:para>Updates a storage area's properties. Returns the Storage object on the pipeline.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates a storage area's properties. Returns the Storage object on the pipeline.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-PWStorageAreaProperties</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="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HostName</maml:name> <maml:description> <maml:para>New Host Name (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: Path --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Path</maml:name> <maml:description> <maml:para>New path for storage area (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: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>New description of storage area (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: 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="false" globbing="false" pipelineInput="false" position="1"> <maml:name>HostName</maml:name> <maml:description> <maml:para>New Host Name (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: Path --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Path</maml:name> <maml:description> <maml:para>New path for storage area (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: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Description</maml:name> <maml:description> <maml:para>New description of storage area (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> <dev:code>Update-PWStorageAreaProperties -Name "Storage 01" -HostName "NewMachineName.company.com" -Path "c:\pwstore\New Path" -Description "New Storage Description"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWStorageAreaReport --> <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-PWStorageAreaReport</command:name> <command:verb>Get</command:verb> <command:noun>PWStorageAreaReport</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWStorageAreaReport</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 ProjectWise folder to report 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: StorageAreaName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>StorageAreaName</maml:name> <maml:description> <maml:para>Name of storage area to report 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: OutputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>OutputFolder</maml:name> <maml:description> <maml:para>Folder path to create output file 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: UseAdminPaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UseAdminPaths</maml:name> <maml:description> <maml:para>When UseAdminPaths is included, administrative paths to the files will be used.".</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: SQLite --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>SQLite</maml:name> <maml:description> <maml:para>Output SQLite rather than XLSX.</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: SkipFileSizeCheck --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipFileSizeCheck</maml:name> <maml:description> <maml:para>When included, skips the file size check.</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: SkipOrphanedFileCheck --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipOrphanedFileCheck</maml:name> <maml:description> <maml:para>When included, skips the check for orphaned files.</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="true (ByValue)" position="0"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder path of ProjectWise folder to report 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: StorageAreaName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>StorageAreaName</maml:name> <maml:description> <maml:para>Name of storage area to report 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: OutputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>OutputFolder</maml:name> <maml:description> <maml:para>Folder path to create output file 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: UseAdminPaths --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>UseAdminPaths</maml:name> <maml:description> <maml:para>When UseAdminPaths is included, administrative paths to the files will be used.".</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: SQLite --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>SQLite</maml:name> <maml:description> <maml:para>Output SQLite rather than XLSX.</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: SkipFileSizeCheck --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipFileSizeCheck</maml:name> <maml:description> <maml:para>When included, skips the file size check.</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: SkipOrphanedFileCheck --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipOrphanedFileCheck</maml:name> <maml:description> <maml:para>When included, skips the check for orphaned files.</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 ProjectWise folder to report on.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of storage area to report on.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Folder path to create output file in.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>The following will create a storage area report for an entire datasource. Get-PWStorageAreaReport -OutputFolder 'D:\Reports' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>The following will create a storage area report for a specified project. Get-PWStorageAreaReport -FolderPath 'Projects\MyProject' -OutputFolder 'D:\Reports' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>The following will create a storage area report for a specified storage area. Get-PWStorageAreaReport -StorageAreaName 'Storage_01' -OutputFolder 'D:\Reports' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>The following will create a storage area report for an entire datasource. Skipping the file size check. Get-PWStorageAreaReport -OutputFolder 'D:\Reports' -SkipFileSizeCheck -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>The following will create a storage area report for an entire datasource. Skipping the orphaned file check. Get-PWStorageAreaReport -OutputFolder 'D:\Reports' -SkipOrphanCheck -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>The UseAdminPaths will use UNC paths rather than literal. Example: '\\BMF-WS2016\C$\ProjectWise\StorageAreas\BMF_PW\Storage_01' The following will create a storage area report for an entire datasource. Using admin paths and skipping the orphaned file check. Get-PWStorageAreaReport -OutputFolder 'D:\Reports' -SkipOrphanCheck -UseAdminPaths -Verbose</dev:code> </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> <dev:code>Add-PWTagDocumentProperty -Name 'Tag01' -TagSetName 'New Tagset' -TagSetType MicroStation -Property DocName -Verbose</dev:code> </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> <dev:code>Add-PWTagProjectProperty -Name 'Tag01' -TagSetName 'New Tagset' -TagSetType MicroStation -Property FolderName -Verbose</dev:code> </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> <dev:code>Add-PWTagFolderProperty -Name 'Tag01' -TagSetName 'New Tagset' -TagSetType MicroStation -Property FolderName -Verbose</dev:code> </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> <dev:code>Export-PWTagMappings -OutputFile c:\temp\tagMappings01.xlsx -TagSetName 'New Tagset' -TagSetType MicroStation -Verbose</dev:code> </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> <dev:code>Export-PWTagMappings -OutputFile c:\temp\tagMappings01.xlsx -TagSetName 'New Tagset' -TagSetType MicroStation -Verbose</dev:code> </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> <dev:code>Add-PWTagProjectProperty -Name 'Tag01' -TagSetName 'New Tagset' -TagSetType MicroStation -Property FolderName -Verbose</dev:code> </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> <dev:code>Add-PWTags 'Tag01','Tag02','Tag03' -TagSetName 'New Tagset' -TagSetType MicroStation -Verbose</dev:code> </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> <dev:code>Add-PWTagset -Name 'New Tagset' -TagSetType MicroStation -Verbose</dev:code> </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> <dev:code>Remove-PWTagset -Name 'New Tagset' -TagSetType MicroStation -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWTagSetAttributeBindings --> <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-PWTagSetAttributeBindings</command:name> <command:verb>Get</command:verb> <command:noun>PWTagSetAttributeBindings</command:noun> <maml:description> <maml:para>Returns all tagset bindings associated with the provided Type, Tag Set, and Attribute.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWTagSetAttributeBindings</maml:name> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>TagSet type (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="true (ByPropertyName)" position="1"> <maml:name>TagSetName</maml:name> <maml:description> <maml:para>TagSet name to return associated attributes for. (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="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>AttributeName</maml:name> <maml:description> <maml:para>Attribute to return all bindings for. (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: Type --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>TagSet type (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="true (ByPropertyName)" position="1"> <maml:name>TagSetName</maml:name> <maml:description> <maml:para>TagSet name to return associated attributes for. (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="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>AttributeName</maml:name> <maml:description> <maml:para>Attribute to return all bindings for. (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>TagSet type (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>TagSet name to return associated attributes for. (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>Attribute to return all bindings for. (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWTagSetAttributeBindings -Type 'Microstation' -TagSetName 'MSTagSet_WorkArea' -AttributeName 'ProjectName' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWTagSetAttributes --> <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-PWTagSetAttributes</command:name> <command:verb>Get</command:verb> <command:noun>PWTagSetAttributes</command:noun> <maml:description> <maml:para>Returns all associated Tag Set attibutes for a provided Type and Tag Set.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWTagSetAttributes</maml:name> <!-- Parameter: Type --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>TagSet type (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="true (ByPropertyName)" position="1"> <maml:name>TagSetName</maml:name> <maml:description> <maml:para>TagSet name to return associated attributes for. (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: Type --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Type</maml:name> <maml:description> <maml:para>TagSet type (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="true (ByPropertyName)" position="1"> <maml:name>TagSetName</maml:name> <maml:description> <maml:para>TagSet name to return associated attributes for. (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>TagSet type (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>TagSet name to return associated attributes for. (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWTagSetAttributes -Type 'Microstation' -TagSetName 'MSTagSet_WorkArea' -Verbose</dev:code> </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> <dev:code>Get-PWTagsets -TagSetType MicroStation</dev:code> </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> <dev:code>Add-PWTestDocuments -NumDocuments 100000 -NumFolders 10000 -FolderDepth 3 -StorageArea Storage1 -TargetPWFolder "Import Test" -SourceFile c:\temp\dummy.txt</dev:code> </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> <dev:code># Create up 100000 test documents in the empty folders under "Import Test\Folder 01" Add-PWTestDocumentsInFolders -NumDocuments 100000 -TargetPWFolder "Import Test\Folder 01" -SourceFile c:\temp\dummy.txt</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Disable-PWTitleBlockUpdate --> <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>Disable-PWTitleBlockUpdate</command:name> <command:verb>Disable</command:verb> <command:noun>PWTitleBlockUpdate</command:noun> <maml:description> <maml:para>Disables the ProjectWise Titleblock update functionality.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Disables the ability to update titleblocks using PowerShell on the current system.</maml:para> </maml:description> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Enable-PWTitleBlockUpdate -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Enable-PWTitleBlockUpdate --> <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>Enable-PWTitleBlockUpdate</command:name> <command:verb>Enable</command:verb> <command:noun>PWTitleBlockUpdate</command:noun> <maml:description> <maml:para>Updates the registry settings which allow for the ProjectWise Titleblock updating.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates the registry settings which allow for the ProjectWise Titleblock updating.</maml:para> </maml:description> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Enable-PWTitleBlockUpdate -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Show-PWTokenFormatted --> <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-PWTokenFormatted</command:name> <command:verb>Show</command:verb> <command:noun>PWTokenFormatted</command:noun> <maml:description> <maml:para>Display token in a readable form.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Display token in a readable form.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Token --> <command:syntaxItem> <maml:name>Show-PWTokenFormatted</maml:name> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>Encoded Token.</maml: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: Token --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Token</maml:name> <maml:description> <maml:para>Encoded Token.</maml: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>Encoded Token.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Show-PWTokenFormatted (Get-PWConnectionClientToken -CreatePWDIToken)</dev:code> </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> <dev:code>Get-PWUsersBySearch -UserName 'pwadmin','ics_admin' | Set-PWUserAdminRights New-PWUserSimple 'pwadmin' | Set-PWUserAdminRights</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWUserAuditTrailRecords --> <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-PWUserAuditTrailRecords</command:name> <command:verb>Get</command:verb> <command:noun>PWUserAuditTrailRecords</command:noun> <maml:description> <maml:para>Reports on user activity from audit trail.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Users --> <command:syntaxItem> <maml:name>Get-PWUserAuditTrailRecords</maml:name> <!-- Parameter: Users --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Users</maml:name> <maml:description> <maml:para>Optional array of users to report on. Should use Get-PWUsersInGroup or Get-PWUsersInUserList or Get-PWUsersByMatch to build 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> <dev:defaultValue>Bentley.ProjectWise.PowerShell.Common.User[]</dev:defaultValue> </command:parameter> <!-- Parameter: StartDate --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Optional start date like '2018-12-27'.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EndDate --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>EndDate</maml:name> <maml:description> <maml:para>Optional end date like '2019-12-27'.</maml: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: Users --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Users</maml:name> <maml:description> <maml:para>Optional array of users to report on. Should use Get-PWUsersInGroup or Get-PWUsersInUserList or Get-PWUsersByMatch to build 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> <dev:defaultValue>Bentley.ProjectWise.PowerShell.Common.User[]</dev:defaultValue> </command:parameter> <!-- Parameter: StartDate --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Optional start date like '2018-12-27'.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EndDate --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>EndDate</maml:name> <maml:description> <maml:para>Optional end date like '2019-12-27'.</maml: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>Optional array of users to report on. Should use Get-PWUsersInGroup or Get-PWUsersInUserList or Get-PWUsersByMatch to build list.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Optional start date like '2018-12-27'.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Optional end date like '2019-12-27'.</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> <dev:code>$users = Get-PWUsersInGroup 'Administrator' Get-PWUserAuditTrailRecords $users -StartDate '2017-01-01' -EndDate '2017-12-31' | New-XLSXWorkbook -OutputFileName C:\temp\useraudittrail05.xlsx</dev:code> </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> <dev:code>Get-PWUserByLastLogin -DaysAgo 30 -Since"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWUserByMatch --> <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-PWUserByMatch</command:name> <command:verb>Remove</command:verb> <command:noun>PWUserByMatch</command:noun> <maml:description> <maml:para>Deletes provided users from the current ProjectWise datasource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes provided users from the current ProjectWise datasource. You can provide a user account to replace the deleted user as items owner.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputUsers --> <command:syntaxItem> <maml:name>Remove-PWUserByMatch</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> <!-- Parameter: UserNameForItems --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserNameForItems</maml:name> <maml:description> <maml:para>Specifies the user account to replace the old user as owner of documents, and other various items. If not included, the current user account is 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> </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> <!-- Parameter: UserNameForItems --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserNameForItems</maml:name> <maml:description> <maml:para>Specifies the user account to replace the old user as owner of documents, and other various items. If not included, the current user account is 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> </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> <dev:code>The following will remove the specified user account. The current user will become owner of deleted users items. Remove-PWUserByMatch -InputUsers (Get-PWUsersByMatch -UserName 'TestUserToRemove') -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>The following will remove the specified user account. The specified UserNameForItems will will become owner of deleted users items. Remove-PWUserByMatch -InputUsers (Get-PWUsersByMatch -UserName 'TestUserToRemove') -UserNameForItems 'brian.flaherty@bentley.com' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWUserDefaultSettings --> <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-PWUserDefaultSettings</command:name> <command:verb>Get</command:verb> <command:noun>PWUserDefaultSettings</command:noun> <maml:description> <maml:para>Gets the default user settings.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWUserDefaultSettings</maml:name> <!-- Parameter: SettingName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>SettingName</maml:name> <maml:description> <maml:para>Setting name to check.</maml:para> <maml:para>Possible values: WorkDir_CanChangeWorkDirSettings, WorkDir_WhenUsingPWExplorer, WorkDir_WhenUsingPWWebServer, General_CanChangeGeneralSettings, General_CredentialExpirationPolicy, General_UseAccessControl, General_CanOnlyLoginThroughWebViewServer, UI_CanChangeUISettings, UI_CanEditSets, UI_CanEditVersions, UI_ShowDialogOnError, UI_ShowProgressDuringFileTransfers, UI_ShowSelectReferenceDocsDialog, UI_ShowLocalDocOrganizerOnLogOut, UI_ShowDescriptionsInsteadOfNames, UI_UseURNLinks, UI_SelectLastUsedFolderInPWExplorer, UI_ShowFileProperties, UI_ShowDocThumbnailInPreviewPane, UI_ShowFullTextSearch, UI_DocProperties_ConfirmSaveChanges, UI_DocProperties_OpenLastViewedTab, UI_DocSearch_OpenAttributesTabFirst, Admin_CanChangeAdminSettings, Admin_EnableAsDelegateUser, Admin_EnableGroupAndUserListOwnership, Admin_ShowAccessControlTabInPreviewPane, Admin_Datasource_CanUseRecycleBin, Admin_Storage_CanCreate, Admin_Storage_CanDelete, Admin_Storage_CanModify, Admin_Storage_ShowAllProperties, Admin_Licensing, NetworkTransfer_CanChangeNetworkTransferSettings, NetworkTransfer_EnableDeltaFileTransfer, NetworkTransfer_CompressClientServerRequestData, NetworkTransfer_EnableFileTransferConnectionSharing, Doc_CanChangeDocSettings, Doc_CanCreate, Doc_CanCreateVersion, Doc_CanModify, Doc_CanDelete, Doc_CanFree, Doc_CanSetFinalStatus, Doc_CanRemoveFinalStatus, Doc_CanChangeState, Doc_UseLocalRecycleBinOnFree, Doc_LeaveLocalCopyOnCheckIn, Doc_LeaveLocalCopyOnFree, Doc_UseUpToDateLocalCopyOnCheckOut, Doc_UseUpToDateLocalCopyOnCopyOut, Doc_UseCaptiveEnvironment, DocList_CanChangeDocListSettings, DocList_ShowSubfolders, DocList_ShowTooltips, DocList_DoubleClickAction, DocList_RefreshDisplay, DocList_ShowAllVersions, Folder_CanChangeFolderSettings, Folder_CanCreate, Folder_CanModify, Folder_CanDelete, Folder_CanChangeWorkflowOrState, Folder_ShowFolderHierarchy, MessageFolders_CanChangeMessageFolderSettings, MessageFolders_EnableMessagePolling, MessageFolders_ShowMessageFolders, MessageFolders_CanCreate, MessageFolders_CanModify, MessageFolders_CanDelete, MessageFolders_CanMove, MessageFolders_CanAccessItems, MessageFolders_CanModifyItems, CustomFolders_CanChangeCustomFolderSettings, CustomFolders_ShowCustomFolders, CustomFolders_PersonalFolders_CanCreate, CustomFolders_PersonalFolders_CanModify, CustomFolders_PersonalFolders_CanDelete, CustomFolders_PersonalFolders_CanMove, CustomFolders_PersonalFolders_CanAddNewItems, CustomFolders_GlobalFolders_CanCreate, CustomFolders_GlobalFolders_CanModify, CustomFolders_GlobalFolders_CanDelete, CustomFolders_GlobalFolders_CanMove, CustomFolders_GlobalFolders_CanAddNewItems, CustomFolders_GlobalFolders_Show, CustomFolders_OtherUsersFolders_CanCreate, CustomFolders_OtherUsersFolders_CanModify, CustomFolders_OtherUsersFolders_CanDelete, CustomFolders_OtherUsersFolders_CanMove, CustomFolders_OtherUsersFolders_CanAddNewItems, CustomFolders_OtherUsersFolders_Show, CanChangeGlobalUserListSettings, AddressBookList_CanCreate, AddressBookList_CanModify, AddressBookList_CanDelete, AccessUserList_CanCreate, AccessUserList_CanModify, AccessUserList_CanDelete, Action_CanChangeActionSettings, Action_ApplySameRulesForAllItems, Action_ShowSelectAnActionDialog, Action_DefaultAction, NewVer_CanChangeNewVerSettings, NewVer_ApplySourceDocAttributes, NewVer_RemoveTargetDocAttributes, NewVer_ApplyDocNameOfSourceDoc, NewVer_ApplyFileNameOfSourceDoc, NewVer_ShowDefineVerRulesDialog, NewVer_VersionStringFormat, NewDoc_CanChangeNewDocSettings, NewDoc_ApplySourceDocAttributes, NewDoc_ShowDefineDocRulesDialog, NewDoc_DocNameFormatRule, NewDoc_DocNameFormat, NewDoc_FileNameFormatRule, NewDoc_FileNameFormat, AuditTrail_CanChangeAuditTrailSettings, AuditTrail_ShowAuditTrailTabInDocProperties, AuditTrail_ShowAuditTrailTabInFolderProperties, AuditTrail_Reports_CanChangeReportSettings, AuditTrail_Reports_ShowPrivateActions, AuditTrail_Reports_ShowActionsOfOtherUsers, AuditTrail_Comments_CanChangeCommentSettings, AuditTrail_Comments_AllowForCheckIn, AuditTrail_Comments_AllowForExport, AuditTrail_Comments_AllowForVersionCreate, AuditTrail_Comments_AllowForStateChange, AuditTrail_Comments_AllowForFinalStatusChange, AuditTrail_Comments_RequireWhereAllowed, AuditTrail_Delete_CanChangeDeleteSettings, AuditTrail_Delete_CanDeleteRecords, ManagedWorkspace_CanChangeManagedConfigSettings, ManagedWorkspace_CanChangeExportErrorHandling, ManagedWorkspace_CanEditPersonalConfigVariables, ManagedWorkspace_ShowDatasourceLevelOptions, ManagedWorkspace_ShowPersonalConfigTab, ManagedWorkspace_ExportRelativePathErrorsHandling, Project_CanChangeProjectSettings, Project_CanCreateAndUpgradeFromFolders, Project_CanChangeTypesAndProperties, Project_CanDelete</maml:para> </maml:description> <command:parameterValue required="true">SettingName</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.UserSetting+SettingName</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">WorkDir_CanChangeWorkDirSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">WorkDir_WhenUsingPWExplorer</command:parameterValue> <command:parameterValue required="false" variableLength="false">WorkDir_WhenUsingPWWebServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_CanChangeGeneralSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_CredentialExpirationPolicy</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_UseAccessControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_CanOnlyLoginThroughWebViewServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_CanChangeUISettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_CanEditSets</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_CanEditVersions</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowDialogOnError</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowProgressDuringFileTransfers</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowSelectReferenceDocsDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowLocalDocOrganizerOnLogOut</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowDescriptionsInsteadOfNames</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_UseURNLinks</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_SelectLastUsedFolderInPWExplorer</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowFileProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowDocThumbnailInPreviewPane</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowFullTextSearch</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_DocProperties_ConfirmSaveChanges</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_DocProperties_OpenLastViewedTab</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_DocSearch_OpenAttributesTabFirst</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_CanChangeAdminSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_EnableAsDelegateUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_EnableGroupAndUserListOwnership</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_ShowAccessControlTabInPreviewPane</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Datasource_CanUseRecycleBin</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_ShowAllProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Licensing</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_CanChangeNetworkTransferSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_EnableDeltaFileTransfer</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_CompressClientServerRequestData</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_EnableFileTransferConnectionSharing</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanChangeDocSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanCreateVersion</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanFree</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanSetFinalStatus</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanRemoveFinalStatus</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanChangeState</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseLocalRecycleBinOnFree</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_LeaveLocalCopyOnCheckIn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_LeaveLocalCopyOnFree</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseUpToDateLocalCopyOnCheckOut</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseUpToDateLocalCopyOnCopyOut</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseCaptiveEnvironment</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_CanChangeDocListSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_ShowSubfolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_ShowTooltips</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_DoubleClickAction</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_RefreshDisplay</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_ShowAllVersions</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanChangeFolderSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanChangeWorkflowOrState</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_ShowFolderHierarchy</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanChangeMessageFolderSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_EnableMessagePolling</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_ShowMessageFolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanAccessItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanModifyItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_CanChangeCustomFolderSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_ShowCustomFolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanAddNewItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanAddNewItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_Show</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanAddNewItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_Show</command:parameterValue> <command:parameterValue required="false" variableLength="false">CanChangeGlobalUserListSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AddressBookList_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AddressBookList_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">AddressBookList_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">AccessUserList_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AccessUserList_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">AccessUserList_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_CanChangeActionSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_ApplySameRulesForAllItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_ShowSelectAnActionDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_DefaultAction</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_CanChangeNewVerSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ApplySourceDocAttributes</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_RemoveTargetDocAttributes</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ApplyDocNameOfSourceDoc</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ApplyFileNameOfSourceDoc</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ShowDefineVerRulesDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_VersionStringFormat</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_CanChangeNewDocSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_ApplySourceDocAttributes</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_ShowDefineDocRulesDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_DocNameFormatRule</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_DocNameFormat</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_FileNameFormatRule</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_FileNameFormat</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_CanChangeAuditTrailSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_ShowAuditTrailTabInDocProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_ShowAuditTrailTabInFolderProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Reports_CanChangeReportSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Reports_ShowPrivateActions</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Reports_ShowActionsOfOtherUsers</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_CanChangeCommentSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForCheckIn</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForExport</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForVersionCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForStateChange</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForFinalStatusChange</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_RequireWhereAllowed</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Delete_CanChangeDeleteSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Delete_CanDeleteRecords</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_CanChangeManagedConfigSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_CanChangeExportErrorHandling</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_CanEditPersonalConfigVariables</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_ShowDatasourceLevelOptions</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_ShowPersonalConfigTab</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_ExportRelativePathErrorsHandling</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanChangeProjectSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanCreateAndUpgradeFromFolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanChangeTypesAndProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanDelete</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SettingName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>SettingName</maml:name> <maml:description> <maml:para>Setting name to check.</maml:para> <maml:para>Possible values: WorkDir_CanChangeWorkDirSettings, WorkDir_WhenUsingPWExplorer, WorkDir_WhenUsingPWWebServer, General_CanChangeGeneralSettings, General_CredentialExpirationPolicy, General_UseAccessControl, General_CanOnlyLoginThroughWebViewServer, UI_CanChangeUISettings, UI_CanEditSets, UI_CanEditVersions, UI_ShowDialogOnError, UI_ShowProgressDuringFileTransfers, UI_ShowSelectReferenceDocsDialog, UI_ShowLocalDocOrganizerOnLogOut, UI_ShowDescriptionsInsteadOfNames, UI_UseURNLinks, UI_SelectLastUsedFolderInPWExplorer, UI_ShowFileProperties, UI_ShowDocThumbnailInPreviewPane, UI_ShowFullTextSearch, UI_DocProperties_ConfirmSaveChanges, UI_DocProperties_OpenLastViewedTab, UI_DocSearch_OpenAttributesTabFirst, Admin_CanChangeAdminSettings, Admin_EnableAsDelegateUser, Admin_EnableGroupAndUserListOwnership, Admin_ShowAccessControlTabInPreviewPane, Admin_Datasource_CanUseRecycleBin, Admin_Storage_CanCreate, Admin_Storage_CanDelete, Admin_Storage_CanModify, Admin_Storage_ShowAllProperties, Admin_Licensing, NetworkTransfer_CanChangeNetworkTransferSettings, NetworkTransfer_EnableDeltaFileTransfer, NetworkTransfer_CompressClientServerRequestData, NetworkTransfer_EnableFileTransferConnectionSharing, Doc_CanChangeDocSettings, Doc_CanCreate, Doc_CanCreateVersion, Doc_CanModify, Doc_CanDelete, Doc_CanFree, Doc_CanSetFinalStatus, Doc_CanRemoveFinalStatus, Doc_CanChangeState, Doc_UseLocalRecycleBinOnFree, Doc_LeaveLocalCopyOnCheckIn, Doc_LeaveLocalCopyOnFree, Doc_UseUpToDateLocalCopyOnCheckOut, Doc_UseUpToDateLocalCopyOnCopyOut, Doc_UseCaptiveEnvironment, DocList_CanChangeDocListSettings, DocList_ShowSubfolders, DocList_ShowTooltips, DocList_DoubleClickAction, DocList_RefreshDisplay, DocList_ShowAllVersions, Folder_CanChangeFolderSettings, Folder_CanCreate, Folder_CanModify, Folder_CanDelete, Folder_CanChangeWorkflowOrState, Folder_ShowFolderHierarchy, MessageFolders_CanChangeMessageFolderSettings, MessageFolders_EnableMessagePolling, MessageFolders_ShowMessageFolders, MessageFolders_CanCreate, MessageFolders_CanModify, MessageFolders_CanDelete, MessageFolders_CanMove, MessageFolders_CanAccessItems, MessageFolders_CanModifyItems, CustomFolders_CanChangeCustomFolderSettings, CustomFolders_ShowCustomFolders, CustomFolders_PersonalFolders_CanCreate, CustomFolders_PersonalFolders_CanModify, CustomFolders_PersonalFolders_CanDelete, CustomFolders_PersonalFolders_CanMove, CustomFolders_PersonalFolders_CanAddNewItems, CustomFolders_GlobalFolders_CanCreate, CustomFolders_GlobalFolders_CanModify, CustomFolders_GlobalFolders_CanDelete, CustomFolders_GlobalFolders_CanMove, CustomFolders_GlobalFolders_CanAddNewItems, CustomFolders_GlobalFolders_Show, CustomFolders_OtherUsersFolders_CanCreate, CustomFolders_OtherUsersFolders_CanModify, CustomFolders_OtherUsersFolders_CanDelete, CustomFolders_OtherUsersFolders_CanMove, CustomFolders_OtherUsersFolders_CanAddNewItems, CustomFolders_OtherUsersFolders_Show, CanChangeGlobalUserListSettings, AddressBookList_CanCreate, AddressBookList_CanModify, AddressBookList_CanDelete, AccessUserList_CanCreate, AccessUserList_CanModify, AccessUserList_CanDelete, Action_CanChangeActionSettings, Action_ApplySameRulesForAllItems, Action_ShowSelectAnActionDialog, Action_DefaultAction, NewVer_CanChangeNewVerSettings, NewVer_ApplySourceDocAttributes, NewVer_RemoveTargetDocAttributes, NewVer_ApplyDocNameOfSourceDoc, NewVer_ApplyFileNameOfSourceDoc, NewVer_ShowDefineVerRulesDialog, NewVer_VersionStringFormat, NewDoc_CanChangeNewDocSettings, NewDoc_ApplySourceDocAttributes, NewDoc_ShowDefineDocRulesDialog, NewDoc_DocNameFormatRule, NewDoc_DocNameFormat, NewDoc_FileNameFormatRule, NewDoc_FileNameFormat, AuditTrail_CanChangeAuditTrailSettings, AuditTrail_ShowAuditTrailTabInDocProperties, AuditTrail_ShowAuditTrailTabInFolderProperties, AuditTrail_Reports_CanChangeReportSettings, AuditTrail_Reports_ShowPrivateActions, AuditTrail_Reports_ShowActionsOfOtherUsers, AuditTrail_Comments_CanChangeCommentSettings, AuditTrail_Comments_AllowForCheckIn, AuditTrail_Comments_AllowForExport, AuditTrail_Comments_AllowForVersionCreate, AuditTrail_Comments_AllowForStateChange, AuditTrail_Comments_AllowForFinalStatusChange, AuditTrail_Comments_RequireWhereAllowed, AuditTrail_Delete_CanChangeDeleteSettings, AuditTrail_Delete_CanDeleteRecords, ManagedWorkspace_CanChangeManagedConfigSettings, ManagedWorkspace_CanChangeExportErrorHandling, ManagedWorkspace_CanEditPersonalConfigVariables, ManagedWorkspace_ShowDatasourceLevelOptions, ManagedWorkspace_ShowPersonalConfigTab, ManagedWorkspace_ExportRelativePathErrorsHandling, Project_CanChangeProjectSettings, Project_CanCreateAndUpgradeFromFolders, Project_CanChangeTypesAndProperties, Project_CanDelete</maml:para> </maml:description> <command:parameterValue required="true">SettingName</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.UserSetting+SettingName</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">WorkDir_CanChangeWorkDirSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">WorkDir_WhenUsingPWExplorer</command:parameterValue> <command:parameterValue required="false" variableLength="false">WorkDir_WhenUsingPWWebServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_CanChangeGeneralSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_CredentialExpirationPolicy</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_UseAccessControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_CanOnlyLoginThroughWebViewServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_CanChangeUISettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_CanEditSets</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_CanEditVersions</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowDialogOnError</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowProgressDuringFileTransfers</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowSelectReferenceDocsDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowLocalDocOrganizerOnLogOut</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowDescriptionsInsteadOfNames</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_UseURNLinks</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_SelectLastUsedFolderInPWExplorer</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowFileProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowDocThumbnailInPreviewPane</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowFullTextSearch</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_DocProperties_ConfirmSaveChanges</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_DocProperties_OpenLastViewedTab</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_DocSearch_OpenAttributesTabFirst</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_CanChangeAdminSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_EnableAsDelegateUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_EnableGroupAndUserListOwnership</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_ShowAccessControlTabInPreviewPane</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Datasource_CanUseRecycleBin</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_ShowAllProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Licensing</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_CanChangeNetworkTransferSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_EnableDeltaFileTransfer</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_CompressClientServerRequestData</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_EnableFileTransferConnectionSharing</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanChangeDocSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanCreateVersion</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanFree</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanSetFinalStatus</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanRemoveFinalStatus</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanChangeState</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseLocalRecycleBinOnFree</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_LeaveLocalCopyOnCheckIn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_LeaveLocalCopyOnFree</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseUpToDateLocalCopyOnCheckOut</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseUpToDateLocalCopyOnCopyOut</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseCaptiveEnvironment</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_CanChangeDocListSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_ShowSubfolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_ShowTooltips</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_DoubleClickAction</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_RefreshDisplay</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_ShowAllVersions</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanChangeFolderSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanChangeWorkflowOrState</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_ShowFolderHierarchy</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanChangeMessageFolderSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_EnableMessagePolling</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_ShowMessageFolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanAccessItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanModifyItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_CanChangeCustomFolderSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_ShowCustomFolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanAddNewItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanAddNewItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_Show</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanAddNewItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_Show</command:parameterValue> <command:parameterValue required="false" variableLength="false">CanChangeGlobalUserListSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AddressBookList_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AddressBookList_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">AddressBookList_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">AccessUserList_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AccessUserList_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">AccessUserList_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_CanChangeActionSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_ApplySameRulesForAllItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_ShowSelectAnActionDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_DefaultAction</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_CanChangeNewVerSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ApplySourceDocAttributes</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_RemoveTargetDocAttributes</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ApplyDocNameOfSourceDoc</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ApplyFileNameOfSourceDoc</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ShowDefineVerRulesDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_VersionStringFormat</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_CanChangeNewDocSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_ApplySourceDocAttributes</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_ShowDefineDocRulesDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_DocNameFormatRule</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_DocNameFormat</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_FileNameFormatRule</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_FileNameFormat</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_CanChangeAuditTrailSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_ShowAuditTrailTabInDocProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_ShowAuditTrailTabInFolderProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Reports_CanChangeReportSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Reports_ShowPrivateActions</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Reports_ShowActionsOfOtherUsers</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_CanChangeCommentSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForCheckIn</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForExport</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForVersionCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForStateChange</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForFinalStatusChange</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_RequireWhereAllowed</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Delete_CanChangeDeleteSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Delete_CanDeleteRecords</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_CanChangeManagedConfigSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_CanChangeExportErrorHandling</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_CanEditPersonalConfigVariables</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_ShowDatasourceLevelOptions</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_ShowPersonalConfigTab</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_ExportRelativePathErrorsHandling</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanChangeProjectSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanCreateAndUpgradeFromFolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanChangeTypesAndProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanDelete</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Get the default user settings. Get-PWUserDefaultSettings</dev:code> </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> <dev:code>Get-PWUsersByMatch -Email "*gmail.com","*bentley.com" | Set-PWUserDisabled</dev:code> </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> <dev:code>Get-PWUsersByMatch -Email "*gmail.com","*bentley.com" | Set-PWUserDisabled</dev:code> </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> <dev:code>Get-PWUsersByMatch -Email "*gmail.com","*bentley.com" | Remove-PWUserFromGroup -GroupName Administrators</dev:code> </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> <dev:code>Get-PWUsersByMatch -Email "*gmail.com","*bentley.com" | Remove-PWUserFromUserList -UserList "Project 10100 Engineers"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWUserHasUseAccessControlOn --> <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-PWUserHasUseAccessControlOn</command:name> <command:verb>Get</command:verb> <command:noun>PWUserHasUseAccessControlOn</command:noun> <maml:description> <maml:para>Get Use Access Control setting for a list of users or for the current user.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Users --> <command:syntaxItem> <maml:name>Get-PWUserHasUseAccessControlOn</maml:name> <!-- Parameter: Users --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Users</maml:name> <maml:description> <maml:para>Target user object(s) from pipeline. Omit to get setting for current user.</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: Users --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Users</maml:name> <maml:description> <maml:para>Target user object(s) from pipeline. Omit to get setting for current user.</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. Omit to get setting for current user.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWUsersByMatch -UserName 'dave*','bryan*' | Get-UserHasAccessControlOn Get-UserHasAccessControlOn # to get setting for current user</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWUserIdentity --> <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-PWUserIdentity</command:name> <command:verb>Set</command:verb> <command:noun>PWUserIdentity</command:noun> <maml:description> <maml:para>Set User IMS Identity or clear Identity Provider or disassociate user from IMS Identity.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Users --> <command:syntaxItem> <maml:name>Set-PWUserIdentity</maml:name> <!-- Parameter: Users --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Users</maml:name> <maml:description> <maml:para>New user names. (Required).</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: Identity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity (if not provided, email 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: Disassociate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Disassociate</maml:name> <maml:description> <maml:para>Removes Federated Identity</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: ClearProvider --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ClearProvider</maml:name> <maml:description> <maml:para>Clears Identity Provider</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: Users --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Users</maml:name> <maml:description> <maml:para>New user names. (Required).</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: Identity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Identity</maml:name> <maml:description> <maml:para>Identity (if not provided, email 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: Disassociate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Disassociate</maml:name> <maml:description> <maml:para>Removes Federated Identity</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: ClearProvider --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ClearProvider</maml:name> <maml:description> <maml:para>Clears Identity Provider</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> <dev:code>#Set the IMS identity to the user's email address. Get-PWUsersByMatch -Email "*gmail.com","*bentley.com" | Set-PWUserIdentity</dev:code> </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> <!-- Parameter: UseClient --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UseClient</maml:name> <maml:description> <maml:para>Set this to set license source to client. Otherwise, will set license source to server.</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: 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> <!-- Parameter: UseClient --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UseClient</maml:name> <maml:description> <maml:para>Set this to set license source to client. Otherwise, will set license source to server.</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>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> <dev:code>Get-PWUsersByMatch -UserName 'dave*','bryan*' | Set-PWUserLicenseSource -UseClient</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWUserListByMatch --> <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-PWUserListByMatch</command:name> <command:verb>Remove</command:verb> <command:noun>PWUserListByMatch</command:noun> <maml:description> <maml:para>Deletes provided userlist(s) from the current ProjectWise datasource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes provided userlist(s) from the current ProjectWise datasource.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputUserLists --> <command:syntaxItem> <maml:name>Remove-PWUserListByMatch</maml:name> <!-- Parameter: InputUserLists --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUserLists</maml:name> <maml:description> <maml:para>Target userlist object(s) from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseUserList[]</command:parameterValue> <dev:type> <maml:name>PWWrapper+ProjectWiseUserList[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWWrapper+ProjectWiseUserList[]</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: UserListName --> <command:syntaxItem> <maml:name>Remove-PWUserListByMatch</maml:name> <!-- Parameter: UserListName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>UserListName</maml:name> <maml:description> <maml:para>UserList name(s) to be deleted.</maml: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: InputUserLists --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUserLists</maml:name> <maml:description> <maml:para>Target userlist object(s) from pipeline.</maml:para> </maml:description> <command:parameterValue required="true">ProjectWiseUserList[]</command:parameterValue> <dev:type> <maml:name>PWWrapper+ProjectWiseUserList[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>PWWrapper+ProjectWiseUserList[]</dev:defaultValue> </command:parameter> <!-- Parameter: UserListName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>UserListName</maml:name> <maml:description> <maml:para>UserList name(s) to be deleted.</maml: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>PWWrapper+ProjectWiseUserList[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target userlist object(s) from pipeline.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>The following will remove the specified userlist. Remove-PWUserListByMatch -InputUserLists (Get-PWUserLists -UserListName 'psUserList1') -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>The following will remove the specified userlists. Remove-PWUserListByMatch -UserListName 'psUserList2', 'psUserList3' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWUserListByName --> <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-PWUserListByName</command:name> <command:verb>New</command:verb> <command:noun>PWUserListByName</command:noun> <maml:description> <maml:para>Create a new ProjectWise UserList.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a new ProjectWise UserList. Returns a ProjectWise UserList Object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: UserList --> <command:syntaxItem> <maml:name>New-PWUserListByName</maml:name> <!-- Parameter: UserList --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>UserList</maml:name> <maml:description> <maml:para>Name of userlist 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: UserListDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserListDescription</maml:name> <maml:description> <maml:para>Description of userlist 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> </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>Name of userlist 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: UserListDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserListDescription</maml:name> <maml:description> <maml:para>Description of userlist 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of userlist to be created.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>This example will create a new ProjectWise UserList with UserList Name ONLY. Description will be the same as the name. New-PSUserListByName -UserList 'MyNewUserList'</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>This example will create a new ProjectWise UserList with UserList Name and Description. New-PSUserListByName -UserList 'MyNewUserList' -UserListDescription 'My New UserList'</dev:code> </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> <dev:code>#Remove users from a user list $userlistNames = Get-PWUserListNames $users = Get-PWUsersByMatch -UserName 'dave*','bryan*' foreach ($ul in $userListName) { Remove-PWUserFromUserList $users -UserList $ul }</dev:code> </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: UserList --> <command:syntaxItem> <maml:name>Set-PWUserListOwners</maml:name> <!-- Parameter: UserList --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>UserList</maml:name> <command:parameterValue required="true">ProjectWiseUserList</command:parameterValue> <dev:type> <maml:name>PWWrapper+ProjectWiseUserList</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> <!-- Parameter set: UserListName --> <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: UserList --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>UserList</maml:name> <command:parameterValue required="true">ProjectWiseUserList</command:parameterValue> <dev:type> <maml:name>PWWrapper+ProjectWiseUserList</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- 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>PWWrapper+ProjectWiseUserList</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> <dev:code>#Example usage for adding a user to the Owners of the specified UserList. Set-PWPWUserListOwners -UserListName 'MyNewUserList' -Owner 'MyUserName' -OwnerType 'u' #Example usage for adding a group to the Owners of the specified UserList. Set-PWPWUserListOwners -UserListName 'MyNewUserList' -Owner 'MyGroup' -OwnerType 'g' #Example usage for adding a userlist to the Owners of the specified UserList. Set-PWPWUserListOwners -UserListName 'MyNewUserList' -Owner 'ULA' -OwnerType 'ul'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWUserListProperties --> <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-PWUserListProperties</command:name> <command:verb>Update</command:verb> <command:noun>PWUserListProperties</command:noun> <maml:description> <maml:para>Updates the user name, description and or email address.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Offers a method to update various user properties. Name, description, email, and password.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-PWUserListProperties</maml:name> <!-- Parameter: InputUserList --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUserList</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">ProjectWiseUserList</command:parameterValue> <dev:type> <maml:name>PWWrapper+ProjectWiseUserList</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewUserListName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>NewUserListName</maml:name> <maml:description> <maml:para>New ProjectWise 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: NewUserListDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>NewUserListDescription</maml:name> <maml:description> <maml:para>New ProjectWise 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputUserList --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUserList</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">ProjectWiseUserList</command:parameterValue> <dev:type> <maml:name>PWWrapper+ProjectWiseUserList</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewUserListName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>NewUserListName</maml:name> <maml:description> <maml:para>New ProjectWise 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: NewUserListDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>NewUserListDescription</maml:name> <maml:description> <maml:para>New ProjectWise 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PWWrapper+ProjectWiseUserList</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> <dev:code>Get-PWUsersByMatch -UserName 'brian flaherty' | Update-PWUserProperties -UserName 'brian.flaherty' -Description 'Brian Flaherty - Bentley' -Email 'brian.flaherty@bentley.com' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>The following will reset the password for the user. Get-PWUsersByMatch -UserName 'psTestUser' | Update-PWUserProperties -Password 'password' -Verbose</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWUserLists --> <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-PWUserLists</command:name> <command:verb>Get</command:verb> <command:noun>PWUserLists</command:noun> <maml:description> <maml:para>Gets the ProjectWise UserList(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the ProjectWise UserList(s) in the current ProjectWise Datasource.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: UserListID --> <command:syntaxItem> <maml:name>Get-PWUserLists</maml:name> <!-- Parameter: UserListID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>UserListID</maml:name> <maml:description> <maml:para>Retrieves the UserList with the given UserListID.</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> <!-- Parameter set: UserListName --> <command:syntaxItem> <maml:name>Get-PWUserLists</maml:name> <!-- Parameter: UserListName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>UserListName</maml:name> <maml:description> <maml:para>Retrieves only UserLists that match this UserListName. If excluded, returns all UserLists. Accepts 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> </command:syntax> <command:parameters> <!-- Parameter: UserListID --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>UserListID</maml:name> <maml:description> <maml:para>Retrieves the UserList with the given UserListID.</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: UserListName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>UserListName</maml:name> <maml:description> <maml:para>Retrieves only UserLists that match this UserListName. If excluded, returns all UserLists. Accepts 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Retrieves the UserList with the given UserListID.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Retrieves only UserLists that match this UserListName. If excluded, returns all UserLists. Accepts wildcards(*).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>This example will return all ProjectWise UserLists. Get-PWUserLists</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>This example will return only the ProjectWise UserList with the specified UserListID. Get-PWUserLists -UserListID 2</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>This example will return only the ProjectWise UserList which matches the specifed UserList Name. Get-PWUserLists -UserListName 'Administrators'</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>This example will return the ProjectWise UserList(s) which match the specified UserList Name with wildcards. Get-PWUserLists -UserListName *Admin*</dev:code> </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> <dev:code>Get-PWUserListsByMember -MamberName 'admin' -MemberType user</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-PWUserListsByMember -MamberName 'administrators' -MemberType group</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Get-PWUserListsByMember -MamberName 'Managers' -MemberType userlist</dev:code> </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> <!-- Parameter set: UserID --> <command:syntaxItem> <maml:name>Get-PWUserListsByUser</maml:name> <!-- Parameter: UserID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>UserID</maml:name> <maml:description> <maml:para>User ID to return userlist membership information. (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: 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> <!-- Parameter: UserID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>UserID</maml:name> <maml:description> <maml:para>User ID to return userlist membership information. (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>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> <dev:code>Get-PWUserListsByUser -UserName 'admin'</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-PWUserListsByUser -UserID 12</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWUserMessagePolling --> <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-PWUserMessagePolling</command:name> <command:verb>Set</command:verb> <command:noun>PWUserMessagePolling</command:noun> <maml:description> <maml:para>Set message polling the indicated users.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputUsers --> <command:syntaxItem> <maml:name>Set-PWUserMessagePolling</maml:name> <!-- Parameter: InputUsers --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUsers</maml:name> <maml:description> <maml:para>Target user object(s) from pipeline. Will process all users if not provided</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> <!-- Parameter: Off --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Off</maml:name> <maml:description> <maml:para>Turn polling off. Will turn on 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InputUsers --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUsers</maml:name> <maml:description> <maml:para>Target user object(s) from pipeline. Will process all users if not provided</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> <!-- Parameter: Off --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Off</maml:name> <maml:description> <maml:para>Turn polling off. Will turn on 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> </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. Will process all users if not provided</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWUsersByMatch -UserName 'dave*','bryan*' | Set-PWUserMessagePolling -Off</dev:code> </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: Get-PWUserPasswordToken --> <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-PWUserPasswordToken</command:name> <command:verb>Get</command:verb> <command:noun>PWUserPasswordToken</command:noun> <maml:description> <maml:para>Gets a service account token if available. Only certain accounts can have this.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-PWUserPasswordToken</maml:name> <!-- Parameter: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</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: Password --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Password</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: UserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>UserName</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: Password --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Password</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:returnValues /> </command:command> <!-- Cmdlet: Update-PWUserProperties --> <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-PWUserProperties</command:name> <command:verb>Update</command:verb> <command:noun>PWUserProperties</command:noun> <maml:description> <maml:para>Updates the user name, description and or email address.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Offers a method to update various user properties. Name, description, email, and password.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-PWUserProperties</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: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserName</maml:name> <maml:description> <maml:para>New ProjectWise 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: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>New ProjectWise 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: Email --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Email</maml:name> <maml:description> <maml:para>New ProjectWise User 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>New ProjectWise User password.</maml: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: UserName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserName</maml:name> <maml:description> <maml:para>New ProjectWise 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: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>New ProjectWise 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: Email --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Email</maml:name> <maml:description> <maml:para>New ProjectWise User 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>New ProjectWise User password.</maml: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> <dev:code>Get-PWUsersByMatch -UserName 'brian flaherty' | Update-PWUserProperties -UserName 'brian.flaherty' -Description 'Brian Flaherty - Bentley' -Email 'brian.flaherty@bentley.com' -Verbose</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>The following will reset the password for the user. Get-PWUsersByMatch -UserName 'psTestUser' | Update-PWUserProperties -Password 'password' -Verbose</dev:code> </command:example> </command:examples> </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> <dev:code>#Remove all project access for a user Clear-PWUserRichProjectRights -UserName 'dave' -ProjectAccess ALL #Remove project delete rights for a user list Clear-PWUserRichProjectRights -UserList 'Project Managers' -ProjectAccess DELETE #Remove project modify rights for a group Clear-PWUserRichProjectRights -Group 'New Dheli Office' -ProjectAccess MODIFY</dev:code> </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> <dev:code>#Set project access for a user Set-PWUserRichProjectRights -UserName 'dave' -ProjectAccess ALL #Set project delete for a user list Set-PWUserRichProjectRights -UserList 'Project Managers' -ProjectAccess DELETE #Set project modify for a group Set-PWUserRichProjectRights -Group 'New Dheli Office' -ProjectAccess MODIFY</dev:code> </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: Identity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Identity</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="6"> <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="7"> <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="8"> <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: Identity --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Identity</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="6"> <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="7"> <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="8"> <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> <dev:code>#will return users which match either or the name wildcards OR users matching the Email wildcard Get-PWUsersByMatch -UserName 'dave*','bryan*' -Email '*@bentley.com'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWUserSetting --> <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-PWUserSetting</command:name> <command:verb>Update</command:verb> <command:noun>PWUserSetting</command:noun> <maml:description> <maml:para>Sets user settings.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputUsers --> <command:syntaxItem> <maml:name>Update-PWUserSetting</maml:name> <!-- Parameter: InputUsers --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUsers</maml:name> <maml:description> <maml:para>Users to update (Required).</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: SettingName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SettingName</maml:name> <maml:description> <maml:para>Setting name to update.</maml:para> <maml:para>Possible values: WorkDir_CanChangeWorkDirSettings, WorkDir_WhenUsingPWExplorer, WorkDir_WhenUsingPWWebServer, General_CanChangeGeneralSettings, General_CredentialExpirationPolicy, General_UseAccessControl, General_CanOnlyLoginThroughWebViewServer, UI_CanChangeUISettings, UI_CanEditSets, UI_CanEditVersions, UI_ShowDialogOnError, UI_ShowProgressDuringFileTransfers, UI_ShowSelectReferenceDocsDialog, UI_ShowLocalDocOrganizerOnLogOut, UI_ShowDescriptionsInsteadOfNames, UI_UseURNLinks, UI_SelectLastUsedFolderInPWExplorer, UI_ShowFileProperties, UI_ShowDocThumbnailInPreviewPane, UI_ShowFullTextSearch, UI_DocProperties_ConfirmSaveChanges, UI_DocProperties_OpenLastViewedTab, UI_DocSearch_OpenAttributesTabFirst, Admin_CanChangeAdminSettings, Admin_EnableAsDelegateUser, Admin_EnableGroupAndUserListOwnership, Admin_ShowAccessControlTabInPreviewPane, Admin_Datasource_CanUseRecycleBin, Admin_Storage_CanCreate, Admin_Storage_CanDelete, Admin_Storage_CanModify, Admin_Storage_ShowAllProperties, Admin_Licensing, NetworkTransfer_CanChangeNetworkTransferSettings, NetworkTransfer_EnableDeltaFileTransfer, NetworkTransfer_CompressClientServerRequestData, NetworkTransfer_EnableFileTransferConnectionSharing, Doc_CanChangeDocSettings, Doc_CanCreate, Doc_CanCreateVersion, Doc_CanModify, Doc_CanDelete, Doc_CanFree, Doc_CanSetFinalStatus, Doc_CanRemoveFinalStatus, Doc_CanChangeState, Doc_UseLocalRecycleBinOnFree, Doc_LeaveLocalCopyOnCheckIn, Doc_LeaveLocalCopyOnFree, Doc_UseUpToDateLocalCopyOnCheckOut, Doc_UseUpToDateLocalCopyOnCopyOut, Doc_UseCaptiveEnvironment, DocList_CanChangeDocListSettings, DocList_ShowSubfolders, DocList_ShowTooltips, DocList_DoubleClickAction, DocList_RefreshDisplay, DocList_ShowAllVersions, Folder_CanChangeFolderSettings, Folder_CanCreate, Folder_CanModify, Folder_CanDelete, Folder_CanChangeWorkflowOrState, Folder_ShowFolderHierarchy, MessageFolders_CanChangeMessageFolderSettings, MessageFolders_EnableMessagePolling, MessageFolders_ShowMessageFolders, MessageFolders_CanCreate, MessageFolders_CanModify, MessageFolders_CanDelete, MessageFolders_CanMove, MessageFolders_CanAccessItems, MessageFolders_CanModifyItems, CustomFolders_CanChangeCustomFolderSettings, CustomFolders_ShowCustomFolders, CustomFolders_PersonalFolders_CanCreate, CustomFolders_PersonalFolders_CanModify, CustomFolders_PersonalFolders_CanDelete, CustomFolders_PersonalFolders_CanMove, CustomFolders_PersonalFolders_CanAddNewItems, CustomFolders_GlobalFolders_CanCreate, CustomFolders_GlobalFolders_CanModify, CustomFolders_GlobalFolders_CanDelete, CustomFolders_GlobalFolders_CanMove, CustomFolders_GlobalFolders_CanAddNewItems, CustomFolders_GlobalFolders_Show, CustomFolders_OtherUsersFolders_CanCreate, CustomFolders_OtherUsersFolders_CanModify, CustomFolders_OtherUsersFolders_CanDelete, CustomFolders_OtherUsersFolders_CanMove, CustomFolders_OtherUsersFolders_CanAddNewItems, CustomFolders_OtherUsersFolders_Show, CanChangeGlobalUserListSettings, AddressBookList_CanCreate, AddressBookList_CanModify, AddressBookList_CanDelete, AccessUserList_CanCreate, AccessUserList_CanModify, AccessUserList_CanDelete, Action_CanChangeActionSettings, Action_ApplySameRulesForAllItems, Action_ShowSelectAnActionDialog, Action_DefaultAction, NewVer_CanChangeNewVerSettings, NewVer_ApplySourceDocAttributes, NewVer_RemoveTargetDocAttributes, NewVer_ApplyDocNameOfSourceDoc, NewVer_ApplyFileNameOfSourceDoc, NewVer_ShowDefineVerRulesDialog, NewVer_VersionStringFormat, NewDoc_CanChangeNewDocSettings, NewDoc_ApplySourceDocAttributes, NewDoc_ShowDefineDocRulesDialog, NewDoc_DocNameFormatRule, NewDoc_DocNameFormat, NewDoc_FileNameFormatRule, NewDoc_FileNameFormat, AuditTrail_CanChangeAuditTrailSettings, AuditTrail_ShowAuditTrailTabInDocProperties, AuditTrail_ShowAuditTrailTabInFolderProperties, AuditTrail_Reports_CanChangeReportSettings, AuditTrail_Reports_ShowPrivateActions, AuditTrail_Reports_ShowActionsOfOtherUsers, AuditTrail_Comments_CanChangeCommentSettings, AuditTrail_Comments_AllowForCheckIn, AuditTrail_Comments_AllowForExport, AuditTrail_Comments_AllowForVersionCreate, AuditTrail_Comments_AllowForStateChange, AuditTrail_Comments_AllowForFinalStatusChange, AuditTrail_Comments_RequireWhereAllowed, AuditTrail_Delete_CanChangeDeleteSettings, AuditTrail_Delete_CanDeleteRecords, ManagedWorkspace_CanChangeManagedConfigSettings, ManagedWorkspace_CanChangeExportErrorHandling, ManagedWorkspace_CanEditPersonalConfigVariables, ManagedWorkspace_ShowDatasourceLevelOptions, ManagedWorkspace_ShowPersonalConfigTab, ManagedWorkspace_ExportRelativePathErrorsHandling, Project_CanChangeProjectSettings, Project_CanCreateAndUpgradeFromFolders, Project_CanChangeTypesAndProperties, Project_CanDelete</maml:para> </maml:description> <command:parameterValue required="true">SettingName</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.UserSetting+SettingName</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>WorkDir_CanChangeWorkDirSettings</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">WorkDir_CanChangeWorkDirSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">WorkDir_WhenUsingPWExplorer</command:parameterValue> <command:parameterValue required="false" variableLength="false">WorkDir_WhenUsingPWWebServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_CanChangeGeneralSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_CredentialExpirationPolicy</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_UseAccessControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_CanOnlyLoginThroughWebViewServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_CanChangeUISettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_CanEditSets</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_CanEditVersions</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowDialogOnError</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowProgressDuringFileTransfers</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowSelectReferenceDocsDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowLocalDocOrganizerOnLogOut</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowDescriptionsInsteadOfNames</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_UseURNLinks</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_SelectLastUsedFolderInPWExplorer</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowFileProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowDocThumbnailInPreviewPane</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowFullTextSearch</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_DocProperties_ConfirmSaveChanges</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_DocProperties_OpenLastViewedTab</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_DocSearch_OpenAttributesTabFirst</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_CanChangeAdminSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_EnableAsDelegateUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_EnableGroupAndUserListOwnership</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_ShowAccessControlTabInPreviewPane</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Datasource_CanUseRecycleBin</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_ShowAllProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Licensing</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_CanChangeNetworkTransferSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_EnableDeltaFileTransfer</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_CompressClientServerRequestData</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_EnableFileTransferConnectionSharing</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanChangeDocSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanCreateVersion</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanFree</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanSetFinalStatus</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanRemoveFinalStatus</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanChangeState</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseLocalRecycleBinOnFree</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_LeaveLocalCopyOnCheckIn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_LeaveLocalCopyOnFree</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseUpToDateLocalCopyOnCheckOut</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseUpToDateLocalCopyOnCopyOut</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseCaptiveEnvironment</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_CanChangeDocListSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_ShowSubfolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_ShowTooltips</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_DoubleClickAction</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_RefreshDisplay</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_ShowAllVersions</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanChangeFolderSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanChangeWorkflowOrState</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_ShowFolderHierarchy</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanChangeMessageFolderSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_EnableMessagePolling</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_ShowMessageFolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanAccessItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanModifyItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_CanChangeCustomFolderSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_ShowCustomFolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanAddNewItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanAddNewItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_Show</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanAddNewItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_Show</command:parameterValue> <command:parameterValue required="false" variableLength="false">CanChangeGlobalUserListSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AddressBookList_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AddressBookList_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">AddressBookList_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">AccessUserList_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AccessUserList_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">AccessUserList_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_CanChangeActionSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_ApplySameRulesForAllItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_ShowSelectAnActionDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_DefaultAction</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_CanChangeNewVerSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ApplySourceDocAttributes</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_RemoveTargetDocAttributes</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ApplyDocNameOfSourceDoc</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ApplyFileNameOfSourceDoc</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ShowDefineVerRulesDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_VersionStringFormat</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_CanChangeNewDocSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_ApplySourceDocAttributes</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_ShowDefineDocRulesDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_DocNameFormatRule</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_DocNameFormat</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_FileNameFormatRule</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_FileNameFormat</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_CanChangeAuditTrailSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_ShowAuditTrailTabInDocProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_ShowAuditTrailTabInFolderProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Reports_CanChangeReportSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Reports_ShowPrivateActions</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Reports_ShowActionsOfOtherUsers</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_CanChangeCommentSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForCheckIn</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForExport</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForVersionCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForStateChange</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForFinalStatusChange</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_RequireWhereAllowed</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Delete_CanChangeDeleteSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Delete_CanDeleteRecords</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_CanChangeManagedConfigSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_CanChangeExportErrorHandling</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_CanEditPersonalConfigVariables</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_ShowDatasourceLevelOptions</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_ShowPersonalConfigTab</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_ExportRelativePathErrorsHandling</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanChangeProjectSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanCreateAndUpgradeFromFolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanChangeTypesAndProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanDelete</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: SettingValue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SettingValue</maml:name> <maml:description> <maml:para>Setting value. Omit to see available values.</maml:para> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject</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>Users to update (Required).</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: SettingName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SettingName</maml:name> <maml:description> <maml:para>Setting name to update.</maml:para> <maml:para>Possible values: WorkDir_CanChangeWorkDirSettings, WorkDir_WhenUsingPWExplorer, WorkDir_WhenUsingPWWebServer, General_CanChangeGeneralSettings, General_CredentialExpirationPolicy, General_UseAccessControl, General_CanOnlyLoginThroughWebViewServer, UI_CanChangeUISettings, UI_CanEditSets, UI_CanEditVersions, UI_ShowDialogOnError, UI_ShowProgressDuringFileTransfers, UI_ShowSelectReferenceDocsDialog, UI_ShowLocalDocOrganizerOnLogOut, UI_ShowDescriptionsInsteadOfNames, UI_UseURNLinks, UI_SelectLastUsedFolderInPWExplorer, UI_ShowFileProperties, UI_ShowDocThumbnailInPreviewPane, UI_ShowFullTextSearch, UI_DocProperties_ConfirmSaveChanges, UI_DocProperties_OpenLastViewedTab, UI_DocSearch_OpenAttributesTabFirst, Admin_CanChangeAdminSettings, Admin_EnableAsDelegateUser, Admin_EnableGroupAndUserListOwnership, Admin_ShowAccessControlTabInPreviewPane, Admin_Datasource_CanUseRecycleBin, Admin_Storage_CanCreate, Admin_Storage_CanDelete, Admin_Storage_CanModify, Admin_Storage_ShowAllProperties, Admin_Licensing, NetworkTransfer_CanChangeNetworkTransferSettings, NetworkTransfer_EnableDeltaFileTransfer, NetworkTransfer_CompressClientServerRequestData, NetworkTransfer_EnableFileTransferConnectionSharing, Doc_CanChangeDocSettings, Doc_CanCreate, Doc_CanCreateVersion, Doc_CanModify, Doc_CanDelete, Doc_CanFree, Doc_CanSetFinalStatus, Doc_CanRemoveFinalStatus, Doc_CanChangeState, Doc_UseLocalRecycleBinOnFree, Doc_LeaveLocalCopyOnCheckIn, Doc_LeaveLocalCopyOnFree, Doc_UseUpToDateLocalCopyOnCheckOut, Doc_UseUpToDateLocalCopyOnCopyOut, Doc_UseCaptiveEnvironment, DocList_CanChangeDocListSettings, DocList_ShowSubfolders, DocList_ShowTooltips, DocList_DoubleClickAction, DocList_RefreshDisplay, DocList_ShowAllVersions, Folder_CanChangeFolderSettings, Folder_CanCreate, Folder_CanModify, Folder_CanDelete, Folder_CanChangeWorkflowOrState, Folder_ShowFolderHierarchy, MessageFolders_CanChangeMessageFolderSettings, MessageFolders_EnableMessagePolling, MessageFolders_ShowMessageFolders, MessageFolders_CanCreate, MessageFolders_CanModify, MessageFolders_CanDelete, MessageFolders_CanMove, MessageFolders_CanAccessItems, MessageFolders_CanModifyItems, CustomFolders_CanChangeCustomFolderSettings, CustomFolders_ShowCustomFolders, CustomFolders_PersonalFolders_CanCreate, CustomFolders_PersonalFolders_CanModify, CustomFolders_PersonalFolders_CanDelete, CustomFolders_PersonalFolders_CanMove, CustomFolders_PersonalFolders_CanAddNewItems, CustomFolders_GlobalFolders_CanCreate, CustomFolders_GlobalFolders_CanModify, CustomFolders_GlobalFolders_CanDelete, CustomFolders_GlobalFolders_CanMove, CustomFolders_GlobalFolders_CanAddNewItems, CustomFolders_GlobalFolders_Show, CustomFolders_OtherUsersFolders_CanCreate, CustomFolders_OtherUsersFolders_CanModify, CustomFolders_OtherUsersFolders_CanDelete, CustomFolders_OtherUsersFolders_CanMove, CustomFolders_OtherUsersFolders_CanAddNewItems, CustomFolders_OtherUsersFolders_Show, CanChangeGlobalUserListSettings, AddressBookList_CanCreate, AddressBookList_CanModify, AddressBookList_CanDelete, AccessUserList_CanCreate, AccessUserList_CanModify, AccessUserList_CanDelete, Action_CanChangeActionSettings, Action_ApplySameRulesForAllItems, Action_ShowSelectAnActionDialog, Action_DefaultAction, NewVer_CanChangeNewVerSettings, NewVer_ApplySourceDocAttributes, NewVer_RemoveTargetDocAttributes, NewVer_ApplyDocNameOfSourceDoc, NewVer_ApplyFileNameOfSourceDoc, NewVer_ShowDefineVerRulesDialog, NewVer_VersionStringFormat, NewDoc_CanChangeNewDocSettings, NewDoc_ApplySourceDocAttributes, NewDoc_ShowDefineDocRulesDialog, NewDoc_DocNameFormatRule, NewDoc_DocNameFormat, NewDoc_FileNameFormatRule, NewDoc_FileNameFormat, AuditTrail_CanChangeAuditTrailSettings, AuditTrail_ShowAuditTrailTabInDocProperties, AuditTrail_ShowAuditTrailTabInFolderProperties, AuditTrail_Reports_CanChangeReportSettings, AuditTrail_Reports_ShowPrivateActions, AuditTrail_Reports_ShowActionsOfOtherUsers, AuditTrail_Comments_CanChangeCommentSettings, AuditTrail_Comments_AllowForCheckIn, AuditTrail_Comments_AllowForExport, AuditTrail_Comments_AllowForVersionCreate, AuditTrail_Comments_AllowForStateChange, AuditTrail_Comments_AllowForFinalStatusChange, AuditTrail_Comments_RequireWhereAllowed, AuditTrail_Delete_CanChangeDeleteSettings, AuditTrail_Delete_CanDeleteRecords, ManagedWorkspace_CanChangeManagedConfigSettings, ManagedWorkspace_CanChangeExportErrorHandling, ManagedWorkspace_CanEditPersonalConfigVariables, ManagedWorkspace_ShowDatasourceLevelOptions, ManagedWorkspace_ShowPersonalConfigTab, ManagedWorkspace_ExportRelativePathErrorsHandling, Project_CanChangeProjectSettings, Project_CanCreateAndUpgradeFromFolders, Project_CanChangeTypesAndProperties, Project_CanDelete</maml:para> </maml:description> <command:parameterValue required="true">SettingName</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.UserSetting+SettingName</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>WorkDir_CanChangeWorkDirSettings</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">WorkDir_CanChangeWorkDirSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">WorkDir_WhenUsingPWExplorer</command:parameterValue> <command:parameterValue required="false" variableLength="false">WorkDir_WhenUsingPWWebServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_CanChangeGeneralSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_CredentialExpirationPolicy</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_UseAccessControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_CanOnlyLoginThroughWebViewServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_CanChangeUISettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_CanEditSets</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_CanEditVersions</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowDialogOnError</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowProgressDuringFileTransfers</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowSelectReferenceDocsDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowLocalDocOrganizerOnLogOut</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowDescriptionsInsteadOfNames</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_UseURNLinks</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_SelectLastUsedFolderInPWExplorer</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowFileProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowDocThumbnailInPreviewPane</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowFullTextSearch</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_DocProperties_ConfirmSaveChanges</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_DocProperties_OpenLastViewedTab</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_DocSearch_OpenAttributesTabFirst</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_CanChangeAdminSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_EnableAsDelegateUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_EnableGroupAndUserListOwnership</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_ShowAccessControlTabInPreviewPane</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Datasource_CanUseRecycleBin</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_ShowAllProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Licensing</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_CanChangeNetworkTransferSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_EnableDeltaFileTransfer</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_CompressClientServerRequestData</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_EnableFileTransferConnectionSharing</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanChangeDocSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanCreateVersion</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanFree</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanSetFinalStatus</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanRemoveFinalStatus</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanChangeState</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseLocalRecycleBinOnFree</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_LeaveLocalCopyOnCheckIn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_LeaveLocalCopyOnFree</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseUpToDateLocalCopyOnCheckOut</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseUpToDateLocalCopyOnCopyOut</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseCaptiveEnvironment</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_CanChangeDocListSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_ShowSubfolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_ShowTooltips</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_DoubleClickAction</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_RefreshDisplay</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_ShowAllVersions</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanChangeFolderSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanChangeWorkflowOrState</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_ShowFolderHierarchy</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanChangeMessageFolderSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_EnableMessagePolling</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_ShowMessageFolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanAccessItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanModifyItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_CanChangeCustomFolderSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_ShowCustomFolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanAddNewItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanAddNewItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_Show</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanAddNewItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_Show</command:parameterValue> <command:parameterValue required="false" variableLength="false">CanChangeGlobalUserListSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AddressBookList_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AddressBookList_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">AddressBookList_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">AccessUserList_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AccessUserList_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">AccessUserList_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_CanChangeActionSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_ApplySameRulesForAllItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_ShowSelectAnActionDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_DefaultAction</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_CanChangeNewVerSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ApplySourceDocAttributes</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_RemoveTargetDocAttributes</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ApplyDocNameOfSourceDoc</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ApplyFileNameOfSourceDoc</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ShowDefineVerRulesDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_VersionStringFormat</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_CanChangeNewDocSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_ApplySourceDocAttributes</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_ShowDefineDocRulesDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_DocNameFormatRule</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_DocNameFormat</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_FileNameFormatRule</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_FileNameFormat</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_CanChangeAuditTrailSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_ShowAuditTrailTabInDocProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_ShowAuditTrailTabInFolderProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Reports_CanChangeReportSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Reports_ShowPrivateActions</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Reports_ShowActionsOfOtherUsers</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_CanChangeCommentSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForCheckIn</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForExport</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForVersionCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForStateChange</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForFinalStatusChange</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_RequireWhereAllowed</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Delete_CanChangeDeleteSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Delete_CanDeleteRecords</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_CanChangeManagedConfigSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_CanChangeExportErrorHandling</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_CanEditPersonalConfigVariables</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_ShowDatasourceLevelOptions</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_ShowPersonalConfigTab</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_ExportRelativePathErrorsHandling</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanChangeProjectSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanCreateAndUpgradeFromFolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanChangeTypesAndProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanDelete</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: SettingValue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SettingValue</maml:name> <maml:description> <maml:para>Setting value. Omit to see available values.</maml:para> </maml:description> <command:parameterValue required="true">PSObject</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSObject</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>Users to update (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Set the myriad settings for a user or users. Get-PWUsersByMatch *dave51* | Update-PWUserSetting -SettingName DocList_DoubleClickAction -SettingValue OpenAsReadOnly | Get-PWUserSettingByUser -SettingName DocList_DoubleClickAction #Get the valid values for that setting. Get-PWUsersByMatch *dave51* | Update-PWUserSetting -SettingName DocList_DoubleClickAction #Set a numeric on/off value. Get-PWUsersByMatch *dave51* | Update-PWUserSetting -SettingName General_UseAccessControl -SettingValue 0 | Get-PWUserSettingByUser -SettingName General_UseAccessControl #Use a variable. $users = Get-PWUsersByMatch *dave51* Update-PWUserSetting $users -SettingName DocList_RefreshDisplay -SettingValue DuringOperation | Get-PWUserSettingByUser -SettingName DocList_RefreshDisplay</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWUserSettingByUser --> <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-PWUserSettingByUser</command:name> <command:verb>Get</command:verb> <command:noun>PWUserSettingByUser</command:noun> <maml:description> <maml:para>Used to get a user setting(s) for a specified user(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-PWUserSEttingByUser cmdlet offers a method to retrieve a user setting(s) for a specified user(s).</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputUsers --> <command:syntaxItem> <maml:name>Get-PWUserSettingByUser</maml:name> <!-- Parameter: InputUsers --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputUsers</maml:name> <maml:description> <maml:para>Users to update (Required).</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: SettingName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SettingName</maml:name> <maml:description> <maml:para>Setting name to get. Omit for all.</maml:para> <maml:para>Possible values: WorkDir_CanChangeWorkDirSettings, WorkDir_WhenUsingPWExplorer, WorkDir_WhenUsingPWWebServer, General_CanChangeGeneralSettings, General_CredentialExpirationPolicy, General_UseAccessControl, General_CanOnlyLoginThroughWebViewServer, UI_CanChangeUISettings, UI_CanEditSets, UI_CanEditVersions, UI_ShowDialogOnError, UI_ShowProgressDuringFileTransfers, UI_ShowSelectReferenceDocsDialog, UI_ShowLocalDocOrganizerOnLogOut, UI_ShowDescriptionsInsteadOfNames, UI_UseURNLinks, UI_SelectLastUsedFolderInPWExplorer, UI_ShowFileProperties, UI_ShowDocThumbnailInPreviewPane, UI_ShowFullTextSearch, UI_DocProperties_ConfirmSaveChanges, UI_DocProperties_OpenLastViewedTab, UI_DocSearch_OpenAttributesTabFirst, Admin_CanChangeAdminSettings, Admin_EnableAsDelegateUser, Admin_EnableGroupAndUserListOwnership, Admin_ShowAccessControlTabInPreviewPane, Admin_Datasource_CanUseRecycleBin, Admin_Storage_CanCreate, Admin_Storage_CanDelete, Admin_Storage_CanModify, Admin_Storage_ShowAllProperties, Admin_Licensing, NetworkTransfer_CanChangeNetworkTransferSettings, NetworkTransfer_EnableDeltaFileTransfer, NetworkTransfer_CompressClientServerRequestData, NetworkTransfer_EnableFileTransferConnectionSharing, Doc_CanChangeDocSettings, Doc_CanCreate, Doc_CanCreateVersion, Doc_CanModify, Doc_CanDelete, Doc_CanFree, Doc_CanSetFinalStatus, Doc_CanRemoveFinalStatus, Doc_CanChangeState, Doc_UseLocalRecycleBinOnFree, Doc_LeaveLocalCopyOnCheckIn, Doc_LeaveLocalCopyOnFree, Doc_UseUpToDateLocalCopyOnCheckOut, Doc_UseUpToDateLocalCopyOnCopyOut, Doc_UseCaptiveEnvironment, DocList_CanChangeDocListSettings, DocList_ShowSubfolders, DocList_ShowTooltips, DocList_DoubleClickAction, DocList_RefreshDisplay, DocList_ShowAllVersions, Folder_CanChangeFolderSettings, Folder_CanCreate, Folder_CanModify, Folder_CanDelete, Folder_CanChangeWorkflowOrState, Folder_ShowFolderHierarchy, MessageFolders_CanChangeMessageFolderSettings, MessageFolders_EnableMessagePolling, MessageFolders_ShowMessageFolders, MessageFolders_CanCreate, MessageFolders_CanModify, MessageFolders_CanDelete, MessageFolders_CanMove, MessageFolders_CanAccessItems, MessageFolders_CanModifyItems, CustomFolders_CanChangeCustomFolderSettings, CustomFolders_ShowCustomFolders, CustomFolders_PersonalFolders_CanCreate, CustomFolders_PersonalFolders_CanModify, CustomFolders_PersonalFolders_CanDelete, CustomFolders_PersonalFolders_CanMove, CustomFolders_PersonalFolders_CanAddNewItems, CustomFolders_GlobalFolders_CanCreate, CustomFolders_GlobalFolders_CanModify, CustomFolders_GlobalFolders_CanDelete, CustomFolders_GlobalFolders_CanMove, CustomFolders_GlobalFolders_CanAddNewItems, CustomFolders_GlobalFolders_Show, CustomFolders_OtherUsersFolders_CanCreate, CustomFolders_OtherUsersFolders_CanModify, CustomFolders_OtherUsersFolders_CanDelete, CustomFolders_OtherUsersFolders_CanMove, CustomFolders_OtherUsersFolders_CanAddNewItems, CustomFolders_OtherUsersFolders_Show, CanChangeGlobalUserListSettings, AddressBookList_CanCreate, AddressBookList_CanModify, AddressBookList_CanDelete, AccessUserList_CanCreate, AccessUserList_CanModify, AccessUserList_CanDelete, Action_CanChangeActionSettings, Action_ApplySameRulesForAllItems, Action_ShowSelectAnActionDialog, Action_DefaultAction, NewVer_CanChangeNewVerSettings, NewVer_ApplySourceDocAttributes, NewVer_RemoveTargetDocAttributes, NewVer_ApplyDocNameOfSourceDoc, NewVer_ApplyFileNameOfSourceDoc, NewVer_ShowDefineVerRulesDialog, NewVer_VersionStringFormat, NewDoc_CanChangeNewDocSettings, NewDoc_ApplySourceDocAttributes, NewDoc_ShowDefineDocRulesDialog, NewDoc_DocNameFormatRule, NewDoc_DocNameFormat, NewDoc_FileNameFormatRule, NewDoc_FileNameFormat, AuditTrail_CanChangeAuditTrailSettings, AuditTrail_ShowAuditTrailTabInDocProperties, AuditTrail_ShowAuditTrailTabInFolderProperties, AuditTrail_Reports_CanChangeReportSettings, AuditTrail_Reports_ShowPrivateActions, AuditTrail_Reports_ShowActionsOfOtherUsers, AuditTrail_Comments_CanChangeCommentSettings, AuditTrail_Comments_AllowForCheckIn, AuditTrail_Comments_AllowForExport, AuditTrail_Comments_AllowForVersionCreate, AuditTrail_Comments_AllowForStateChange, AuditTrail_Comments_AllowForFinalStatusChange, AuditTrail_Comments_RequireWhereAllowed, AuditTrail_Delete_CanChangeDeleteSettings, AuditTrail_Delete_CanDeleteRecords, ManagedWorkspace_CanChangeManagedConfigSettings, ManagedWorkspace_CanChangeExportErrorHandling, ManagedWorkspace_CanEditPersonalConfigVariables, ManagedWorkspace_ShowDatasourceLevelOptions, ManagedWorkspace_ShowPersonalConfigTab, ManagedWorkspace_ExportRelativePathErrorsHandling, Project_CanChangeProjectSettings, Project_CanCreateAndUpgradeFromFolders, Project_CanChangeTypesAndProperties, Project_CanDelete</maml:para> </maml:description> <command:parameterValue required="true">SettingName</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.UserSetting+SettingName</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">WorkDir_CanChangeWorkDirSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">WorkDir_WhenUsingPWExplorer</command:parameterValue> <command:parameterValue required="false" variableLength="false">WorkDir_WhenUsingPWWebServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_CanChangeGeneralSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_CredentialExpirationPolicy</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_UseAccessControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_CanOnlyLoginThroughWebViewServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_CanChangeUISettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_CanEditSets</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_CanEditVersions</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowDialogOnError</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowProgressDuringFileTransfers</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowSelectReferenceDocsDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowLocalDocOrganizerOnLogOut</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowDescriptionsInsteadOfNames</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_UseURNLinks</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_SelectLastUsedFolderInPWExplorer</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowFileProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowDocThumbnailInPreviewPane</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowFullTextSearch</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_DocProperties_ConfirmSaveChanges</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_DocProperties_OpenLastViewedTab</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_DocSearch_OpenAttributesTabFirst</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_CanChangeAdminSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_EnableAsDelegateUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_EnableGroupAndUserListOwnership</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_ShowAccessControlTabInPreviewPane</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Datasource_CanUseRecycleBin</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_ShowAllProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Licensing</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_CanChangeNetworkTransferSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_EnableDeltaFileTransfer</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_CompressClientServerRequestData</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_EnableFileTransferConnectionSharing</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanChangeDocSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanCreateVersion</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanFree</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanSetFinalStatus</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanRemoveFinalStatus</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanChangeState</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseLocalRecycleBinOnFree</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_LeaveLocalCopyOnCheckIn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_LeaveLocalCopyOnFree</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseUpToDateLocalCopyOnCheckOut</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseUpToDateLocalCopyOnCopyOut</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseCaptiveEnvironment</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_CanChangeDocListSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_ShowSubfolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_ShowTooltips</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_DoubleClickAction</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_RefreshDisplay</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_ShowAllVersions</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanChangeFolderSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanChangeWorkflowOrState</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_ShowFolderHierarchy</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanChangeMessageFolderSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_EnableMessagePolling</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_ShowMessageFolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanAccessItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanModifyItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_CanChangeCustomFolderSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_ShowCustomFolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanAddNewItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanAddNewItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_Show</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanAddNewItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_Show</command:parameterValue> <command:parameterValue required="false" variableLength="false">CanChangeGlobalUserListSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AddressBookList_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AddressBookList_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">AddressBookList_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">AccessUserList_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AccessUserList_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">AccessUserList_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_CanChangeActionSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_ApplySameRulesForAllItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_ShowSelectAnActionDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_DefaultAction</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_CanChangeNewVerSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ApplySourceDocAttributes</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_RemoveTargetDocAttributes</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ApplyDocNameOfSourceDoc</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ApplyFileNameOfSourceDoc</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ShowDefineVerRulesDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_VersionStringFormat</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_CanChangeNewDocSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_ApplySourceDocAttributes</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_ShowDefineDocRulesDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_DocNameFormatRule</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_DocNameFormat</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_FileNameFormatRule</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_FileNameFormat</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_CanChangeAuditTrailSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_ShowAuditTrailTabInDocProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_ShowAuditTrailTabInFolderProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Reports_CanChangeReportSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Reports_ShowPrivateActions</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Reports_ShowActionsOfOtherUsers</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_CanChangeCommentSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForCheckIn</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForExport</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForVersionCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForStateChange</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForFinalStatusChange</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_RequireWhereAllowed</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Delete_CanChangeDeleteSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Delete_CanDeleteRecords</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_CanChangeManagedConfigSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_CanChangeExportErrorHandling</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_CanEditPersonalConfigVariables</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_ShowDatasourceLevelOptions</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_ShowPersonalConfigTab</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_ExportRelativePathErrorsHandling</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanChangeProjectSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanCreateAndUpgradeFromFolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanChangeTypesAndProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanDelete</command:parameterValue> </command:parameterValueGroup> </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>Users to update (Required).</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: SettingName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SettingName</maml:name> <maml:description> <maml:para>Setting name to get. Omit for all.</maml:para> <maml:para>Possible values: WorkDir_CanChangeWorkDirSettings, WorkDir_WhenUsingPWExplorer, WorkDir_WhenUsingPWWebServer, General_CanChangeGeneralSettings, General_CredentialExpirationPolicy, General_UseAccessControl, General_CanOnlyLoginThroughWebViewServer, UI_CanChangeUISettings, UI_CanEditSets, UI_CanEditVersions, UI_ShowDialogOnError, UI_ShowProgressDuringFileTransfers, UI_ShowSelectReferenceDocsDialog, UI_ShowLocalDocOrganizerOnLogOut, UI_ShowDescriptionsInsteadOfNames, UI_UseURNLinks, UI_SelectLastUsedFolderInPWExplorer, UI_ShowFileProperties, UI_ShowDocThumbnailInPreviewPane, UI_ShowFullTextSearch, UI_DocProperties_ConfirmSaveChanges, UI_DocProperties_OpenLastViewedTab, UI_DocSearch_OpenAttributesTabFirst, Admin_CanChangeAdminSettings, Admin_EnableAsDelegateUser, Admin_EnableGroupAndUserListOwnership, Admin_ShowAccessControlTabInPreviewPane, Admin_Datasource_CanUseRecycleBin, Admin_Storage_CanCreate, Admin_Storage_CanDelete, Admin_Storage_CanModify, Admin_Storage_ShowAllProperties, Admin_Licensing, NetworkTransfer_CanChangeNetworkTransferSettings, NetworkTransfer_EnableDeltaFileTransfer, NetworkTransfer_CompressClientServerRequestData, NetworkTransfer_EnableFileTransferConnectionSharing, Doc_CanChangeDocSettings, Doc_CanCreate, Doc_CanCreateVersion, Doc_CanModify, Doc_CanDelete, Doc_CanFree, Doc_CanSetFinalStatus, Doc_CanRemoveFinalStatus, Doc_CanChangeState, Doc_UseLocalRecycleBinOnFree, Doc_LeaveLocalCopyOnCheckIn, Doc_LeaveLocalCopyOnFree, Doc_UseUpToDateLocalCopyOnCheckOut, Doc_UseUpToDateLocalCopyOnCopyOut, Doc_UseCaptiveEnvironment, DocList_CanChangeDocListSettings, DocList_ShowSubfolders, DocList_ShowTooltips, DocList_DoubleClickAction, DocList_RefreshDisplay, DocList_ShowAllVersions, Folder_CanChangeFolderSettings, Folder_CanCreate, Folder_CanModify, Folder_CanDelete, Folder_CanChangeWorkflowOrState, Folder_ShowFolderHierarchy, MessageFolders_CanChangeMessageFolderSettings, MessageFolders_EnableMessagePolling, MessageFolders_ShowMessageFolders, MessageFolders_CanCreate, MessageFolders_CanModify, MessageFolders_CanDelete, MessageFolders_CanMove, MessageFolders_CanAccessItems, MessageFolders_CanModifyItems, CustomFolders_CanChangeCustomFolderSettings, CustomFolders_ShowCustomFolders, CustomFolders_PersonalFolders_CanCreate, CustomFolders_PersonalFolders_CanModify, CustomFolders_PersonalFolders_CanDelete, CustomFolders_PersonalFolders_CanMove, CustomFolders_PersonalFolders_CanAddNewItems, CustomFolders_GlobalFolders_CanCreate, CustomFolders_GlobalFolders_CanModify, CustomFolders_GlobalFolders_CanDelete, CustomFolders_GlobalFolders_CanMove, CustomFolders_GlobalFolders_CanAddNewItems, CustomFolders_GlobalFolders_Show, CustomFolders_OtherUsersFolders_CanCreate, CustomFolders_OtherUsersFolders_CanModify, CustomFolders_OtherUsersFolders_CanDelete, CustomFolders_OtherUsersFolders_CanMove, CustomFolders_OtherUsersFolders_CanAddNewItems, CustomFolders_OtherUsersFolders_Show, CanChangeGlobalUserListSettings, AddressBookList_CanCreate, AddressBookList_CanModify, AddressBookList_CanDelete, AccessUserList_CanCreate, AccessUserList_CanModify, AccessUserList_CanDelete, Action_CanChangeActionSettings, Action_ApplySameRulesForAllItems, Action_ShowSelectAnActionDialog, Action_DefaultAction, NewVer_CanChangeNewVerSettings, NewVer_ApplySourceDocAttributes, NewVer_RemoveTargetDocAttributes, NewVer_ApplyDocNameOfSourceDoc, NewVer_ApplyFileNameOfSourceDoc, NewVer_ShowDefineVerRulesDialog, NewVer_VersionStringFormat, NewDoc_CanChangeNewDocSettings, NewDoc_ApplySourceDocAttributes, NewDoc_ShowDefineDocRulesDialog, NewDoc_DocNameFormatRule, NewDoc_DocNameFormat, NewDoc_FileNameFormatRule, NewDoc_FileNameFormat, AuditTrail_CanChangeAuditTrailSettings, AuditTrail_ShowAuditTrailTabInDocProperties, AuditTrail_ShowAuditTrailTabInFolderProperties, AuditTrail_Reports_CanChangeReportSettings, AuditTrail_Reports_ShowPrivateActions, AuditTrail_Reports_ShowActionsOfOtherUsers, AuditTrail_Comments_CanChangeCommentSettings, AuditTrail_Comments_AllowForCheckIn, AuditTrail_Comments_AllowForExport, AuditTrail_Comments_AllowForVersionCreate, AuditTrail_Comments_AllowForStateChange, AuditTrail_Comments_AllowForFinalStatusChange, AuditTrail_Comments_RequireWhereAllowed, AuditTrail_Delete_CanChangeDeleteSettings, AuditTrail_Delete_CanDeleteRecords, ManagedWorkspace_CanChangeManagedConfigSettings, ManagedWorkspace_CanChangeExportErrorHandling, ManagedWorkspace_CanEditPersonalConfigVariables, ManagedWorkspace_ShowDatasourceLevelOptions, ManagedWorkspace_ShowPersonalConfigTab, ManagedWorkspace_ExportRelativePathErrorsHandling, Project_CanChangeProjectSettings, Project_CanCreateAndUpgradeFromFolders, Project_CanChangeTypesAndProperties, Project_CanDelete</maml:para> </maml:description> <command:parameterValue required="true">SettingName</command:parameterValue> <dev:type> <maml:name>PWPS_DAB.UserSetting+SettingName</maml:name> <maml:uri /> </dev:type> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">WorkDir_CanChangeWorkDirSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">WorkDir_WhenUsingPWExplorer</command:parameterValue> <command:parameterValue required="false" variableLength="false">WorkDir_WhenUsingPWWebServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_CanChangeGeneralSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_CredentialExpirationPolicy</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_UseAccessControl</command:parameterValue> <command:parameterValue required="false" variableLength="false">General_CanOnlyLoginThroughWebViewServer</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_CanChangeUISettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_CanEditSets</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_CanEditVersions</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowDialogOnError</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowProgressDuringFileTransfers</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowSelectReferenceDocsDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowLocalDocOrganizerOnLogOut</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowDescriptionsInsteadOfNames</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_UseURNLinks</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_SelectLastUsedFolderInPWExplorer</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowFileProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowDocThumbnailInPreviewPane</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_ShowFullTextSearch</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_DocProperties_ConfirmSaveChanges</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_DocProperties_OpenLastViewedTab</command:parameterValue> <command:parameterValue required="false" variableLength="false">UI_DocSearch_OpenAttributesTabFirst</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_CanChangeAdminSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_EnableAsDelegateUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_EnableGroupAndUserListOwnership</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_ShowAccessControlTabInPreviewPane</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Datasource_CanUseRecycleBin</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Storage_ShowAllProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">Admin_Licensing</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_CanChangeNetworkTransferSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_EnableDeltaFileTransfer</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_CompressClientServerRequestData</command:parameterValue> <command:parameterValue required="false" variableLength="false">NetworkTransfer_EnableFileTransferConnectionSharing</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanChangeDocSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanCreateVersion</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanFree</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanSetFinalStatus</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanRemoveFinalStatus</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_CanChangeState</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseLocalRecycleBinOnFree</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_LeaveLocalCopyOnCheckIn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_LeaveLocalCopyOnFree</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseUpToDateLocalCopyOnCheckOut</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseUpToDateLocalCopyOnCopyOut</command:parameterValue> <command:parameterValue required="false" variableLength="false">Doc_UseCaptiveEnvironment</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_CanChangeDocListSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_ShowSubfolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_ShowTooltips</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_DoubleClickAction</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_RefreshDisplay</command:parameterValue> <command:parameterValue required="false" variableLength="false">DocList_ShowAllVersions</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanChangeFolderSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_CanChangeWorkflowOrState</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder_ShowFolderHierarchy</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanChangeMessageFolderSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_EnableMessagePolling</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_ShowMessageFolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanAccessItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">MessageFolders_CanModifyItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_CanChangeCustomFolderSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_ShowCustomFolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_PersonalFolders_CanAddNewItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_CanAddNewItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_GlobalFolders_Show</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanMove</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_CanAddNewItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">CustomFolders_OtherUsersFolders_Show</command:parameterValue> <command:parameterValue required="false" variableLength="false">CanChangeGlobalUserListSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AddressBookList_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AddressBookList_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">AddressBookList_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">AccessUserList_CanCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AccessUserList_CanModify</command:parameterValue> <command:parameterValue required="false" variableLength="false">AccessUserList_CanDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_CanChangeActionSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_ApplySameRulesForAllItems</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_ShowSelectAnActionDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">Action_DefaultAction</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_CanChangeNewVerSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ApplySourceDocAttributes</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_RemoveTargetDocAttributes</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ApplyDocNameOfSourceDoc</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ApplyFileNameOfSourceDoc</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_ShowDefineVerRulesDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewVer_VersionStringFormat</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_CanChangeNewDocSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_ApplySourceDocAttributes</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_ShowDefineDocRulesDialog</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_DocNameFormatRule</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_DocNameFormat</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_FileNameFormatRule</command:parameterValue> <command:parameterValue required="false" variableLength="false">NewDoc_FileNameFormat</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_CanChangeAuditTrailSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_ShowAuditTrailTabInDocProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_ShowAuditTrailTabInFolderProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Reports_CanChangeReportSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Reports_ShowPrivateActions</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Reports_ShowActionsOfOtherUsers</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_CanChangeCommentSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForCheckIn</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForExport</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForVersionCreate</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForStateChange</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_AllowForFinalStatusChange</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Comments_RequireWhereAllowed</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Delete_CanChangeDeleteSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">AuditTrail_Delete_CanDeleteRecords</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_CanChangeManagedConfigSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_CanChangeExportErrorHandling</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_CanEditPersonalConfigVariables</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_ShowDatasourceLevelOptions</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_ShowPersonalConfigTab</command:parameterValue> <command:parameterValue required="false" variableLength="false">ManagedWorkspace_ExportRelativePathErrorsHandling</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanChangeProjectSettings</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanCreateAndUpgradeFromFolders</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanChangeTypesAndProperties</command:parameterValue> <command:parameterValue required="false" variableLength="false">Project_CanDelete</command:parameterValue> </command:parameterValueGroup> </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>Users to update (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Returns all of the user settings for the specified user. Get-PWUserSettingByUser -InputUsers (Get-PWUsersByMatch -UserName Brian.flaherty)</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Piping ALL user accounts to the Get-PWUserSettingByUser cmdlet and returning ONLY the value for the WorkDir_WhenUsingPWExplorer user setting. Get-PWUsersByMatch | Get-PWUserSettingByUser -SettingName WorkDir_WhenUsingPWExplorer</dev:code> </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> <!-- Parameter: IMSUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>IMSUser</maml:name> <maml:description> <maml:para>Will use Email as Federated Identity</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: 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> <!-- Parameter: IMSUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>IMSUser</maml:name> <maml:description> <maml:para>Will use Email as Federated Identity</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> <dev:code>#create logical users using secure string password New-PWUserSimple "MyNewUserName","YourNewUserName" -Password $secureString #create domain user New-PWUserSimple Win.User -SecurityProvider YourDomain -Email Win.User@YourDomain.com</dev:code> </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> <dev:code>Get-PWUsersInGroup Adminstrators | Set-PWUserAdminRights</dev:code> </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> <dev:code>Get-PWUsersInUserList 'Project Engineers' | Set-PWUserDisabled</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWUsersLoggedIn --> <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-PWUsersLoggedIn</command:name> <command:verb>Get</command:verb> <command:noun>PWUsersLoggedIn</command:noun> <maml:description> <maml:para>Returns an array of user objects for all users logged into the current datasource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns an array of user objects for all users logged into 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> <dev:code>$pwUsersLoggedIn = Get-PWUsersLoggedIn</dev:code> </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: InputUsers --> <command:parameter required="false" 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="false" globbing="false" pipelineInput="false" position="1"> <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: ConnectedProjectUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>DEPRECATED -- use Token instead.</maml:para> </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="11"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>DEPRECATED -- use Token instead.</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: 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: Token --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Token</maml:name> <maml:description> <maml:para>Pass token to use for connection.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Roles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>Roles</maml:name> <maml:description> <maml:para>Array of roles.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectedProjectId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>Pass token to use for connection.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Emails --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>Emails</maml:name> <maml:description> <maml:para>Array of user emails (e.g. "user.one@companytwo.com","user.two@companythree.com").</maml: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: InputUsers --> <command:parameter required="false" 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="false" globbing="false" pipelineInput="false" position="1"> <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="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="10"> <maml:name>ConnectedProjectUser</maml:name> <maml:description> <maml:para>DEPRECATED -- use Token instead.</maml:para> </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="11"> <maml:name>ConnectedProjectPassword</maml:name> <maml:description> <maml:para>DEPRECATED -- use Token instead.</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: Token --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Token</maml:name> <maml:description> <maml:para>Pass token to use for connection.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Roles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>Roles</maml:name> <maml:description> <maml:para>Array of roles.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectedProjectId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>Pass token to use for connection.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Emails --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>Emails</maml:name> <maml:description> <maml:para>Array of user emails (e.g. "user.one@companytwo.com","user.two@companythree.com").</maml: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 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> <dev:code>#Example usage for adding users to a CONNECTED project. #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 Get-PWUserByLastLogin -DaysAgo 365 -Since | Add-PWUsersToConnectedProject -FolderPath "PWPS Connected Project Test 6\Projects 2\Project A"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>$bentleyToken = Get-PWConnectionClientToken $suffix = Get-RandomString -Length 5 -Characters 'ABCEDFGHIJKLMNOPQRSTUVWXYZ' $connProj = Add-PWConnectedProject -ConnectedProjectName "Golf Hotel Indigo $suffix" -ConnectedProjectNumber "Golf Hotel Indigo $suffix" -MakeUnique -Location 'Durham, NC' -AssetType 'Airport' -WSGURL 'https://decide-pwce-us-ws.bentley.com/ws' -Token $bentleyToken #wait a few seconds before querying for the roles. It takes a bit for them all to get populated $roles = Get-PWConnectedProjectRoles $connProj -Token $bentleyToken Add-PWUsersToConnectedProject -ConnectedProjectId $connProj -Token $bentleyToken -Emails "keith.meyers@bentley.com","al.gray@bentley.com" -Roles $roles</dev:code> </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: Roles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>Roles</maml:name> <maml:description> <maml:para>Array of roles.</maml:para> </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="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>DEPRECATED -- use Token instead.</maml:para> </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>DEPRECATED -- use Token instead.</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: Token --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>Token</maml:name> <maml:description> <maml:para>Token to use.</maml: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="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>DEPRECATED -- use Token instead.</maml:para> </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>DEPRECATED -- use Token instead.</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: Token --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>Token</maml:name> <maml:description> <maml:para>Token to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Roles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>Roles</maml:name> <maml:description> <maml:para>Array of roles.</maml: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> <dev:code>#Example usage for adding users to a CONNECTED project. #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 Add-PWUsersToConnectedProjectByGroup -FolderPath "PWPS Connected Project Test 6\Projects 2\Project A" -Group "Project Managers"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWUsersToConnectedProjectByUserLists --> <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-PWUsersToConnectedProjectByUserLists</command:name> <command:verb>Add</command:verb> <command:noun>PWUsersToConnectedProjectByUserLists</command:noun> <maml:description> <maml:para>Takes an array of folders and associates users in the passed user lists or in all the project's user lists with the associated CONNECTed project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes an array of folders and associates users in the passed user lists or in all the project's user lists with the associated CONNECTed project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolders --> <command:syntaxItem> <maml:name>Add-PWUsersToConnectedProjectByUserLists</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 ProjectWise folders from pipeline. The rich projects with CONNECTed projects will have users added.</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: UserLists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserLists</maml:name> <maml:description> <maml:para>Users Lists containing participants to add to CONNECTed project. Leave blank and all users in the project user lists will be added.</maml:para> </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: Token --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Token</maml:name> <maml:description> <maml:para>Token to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Will match on this filter so that not all user lists get the same rights. (e.g. "*Project Managers" or "*Drafters").</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Roles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>Roles</maml:name> <maml:description> <maml:para>Array of roles.</maml: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 ProjectWise folders from pipeline. The rich projects with CONNECTed projects will have users added.</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: UserLists --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserLists</maml:name> <maml:description> <maml:para>Users Lists containing participants to add to CONNECTed project. Leave blank and all users in the project user lists will be added.</maml:para> </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: Token --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Token</maml:name> <maml:description> <maml:para>Token to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Filter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Will match on this filter so that not all user lists get the same rights. (e.g. "*Project Managers" or "*Drafters").</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Roles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>Roles</maml:name> <maml:description> <maml:para>Array of roles.</maml: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 ProjectWise folders from pipeline. The rich projects with CONNECTed projects will have users added.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Example usage for adding users to a CONNECTED project. #Will add all the users in all the user lists to each Connected Project. Get-PWRichProjects | Add-PWUsersToConnectedProjectByUserLists -Review -Issue -Receive #Will add all the users in the filtered user lists to the Connected Projects. Get-PWFolders -FolderPath 'Projects\2020-05-19' | Add-PWUsersToConnectedProjectByUserLists -Review -Issue -Receive -Filter "*Managers*" -Roles "Project Manager"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWUserSynchronizationServiceSources --> <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-PWUserSynchronizationServiceSources</command:name> <command:verb>Add</command:verb> <command:noun>PWUserSynchronizationServiceSources</command:noun> <maml:description> <maml:para>Add a group or user to the user synchronization service list.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-PWUserSynchronizationServiceSources</maml:name> <!-- Parameter: Domain --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Domain to search. (e.g. Bentley.com)</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MachineName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MachineName</maml:name> <maml:description> <maml:para>Machine to search. Ignored if Domain is provided. Defaults to local machine if neither domain nor machine name is 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: Users --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Users</maml:name> <maml:description> <maml:para>Users 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: Groups --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Groups 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> </command:syntax> <command:parameters> <!-- Parameter: Domain --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Domain</maml:name> <maml:description> <maml:para>Domain to search. (e.g. Bentley.com)</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MachineName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>MachineName</maml:name> <maml:description> <maml:para>Machine to search. Ignored if Domain is provided. Defaults to local machine if neither domain nor machine name is 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: Users --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Users</maml:name> <maml:description> <maml:para>Users 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: Groups --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Groups</maml:name> <maml:description> <maml:para>Groups 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:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Add-PWUserSynchronizationServiceSources -Users Guest,MSSQLSERVER00,MSSQLSERVER01 -Groups Guests,IIS_IUSRS Add-PWUserSynchronizationServiceSources -Domain Bentley.com -Groups "V-ConnectedColleaguesinCanada","V-ConnectedColleaguesinAustralia" -Users "dave.brumbaugh","marty.nickel"</dev:code> </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: DoNotChangeUserType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotChangeUserType</maml:name> <maml:description> <maml:para>Do not change user type to federated.</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: 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> <!-- Parameter: DoNotChangeUserType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DoNotChangeUserType</maml:name> <maml:description> <maml:para>Do not change user type to federated.</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>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> <dev:code>#Will update user account to a Federated user and update Identity name to the user's email. Get-PWUserByMatch -Email '*bentley.com' | Convert-PWUserToFederated</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Will update user account to a Federated Identity and update Identity name. Convert-PWUserToFederated -UserID 2 -IdentityName 'PWUser1'</dev:code> </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> <dev:code>Get-PWUsersByMatch -Email "*gmail.com","*bentley.com" | Add-PWUserToGroup -GroupName "Administrators"</dev:code> </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> <dev:code>Get-PWUsersByMatch -Email "*gmail.com","*bentley.com" | Add-PWUserToUserList -UserList "Project 10100 Engineers"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWUserUseAccessControl --> <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-PWUserUseAccessControl</command:name> <command:verb>Set</command:verb> <command:noun>PWUserUseAccessControl</command:noun> <maml:description> <maml:para>Set Use Access Control setting for a list of users or for the current user.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Users --> <command:syntaxItem> <maml:name>Set-PWUserUseAccessControl</maml:name> <!-- Parameter: Users --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Users</maml:name> <maml:description> <maml:para>Target user object(s) from pipeline. Omit to get setting for current user.</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> <!-- Parameter: TurnOff --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>TurnOff</maml:name> <maml:description> <maml:para>Set to turn access control off.</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: Users --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Users</maml:name> <maml:description> <maml:para>Target user object(s) from pipeline. Omit to get setting for current user.</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> <!-- Parameter: TurnOff --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>TurnOff</maml:name> <maml:description> <maml:para>Set to turn access control off.</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>Bentley.ProjectWise.PowerShell.Common.User[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target user object(s) from pipeline. Omit to get setting for current user.</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>Set to turn access control off.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWUsersByMatch -UserName 'dave*','bryan*' | Set-PWUserUseAccessControl -TurnOff Set-PWUserUseAccessControl -TurnOff # to set use access control off for current user</dev:code> </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> <dev:code>Get-PWUserWorkingDirectory -UserName pwadmin</dev:code> </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="1"> <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 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> </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="1"> <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="false" 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: 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="1"> <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: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 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: UserId --> <command:parameter required="false" 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="1"> <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 process.</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> <dev:code>#Set working directory for a user Set-PWUserWorkingDirectory -UserName pwadmin -WorkingDirectory 'c:\pwwork\ds1\pwadmin' #Set working directory for an array of users $users = Get-PWUsersByMatch xadmin13, xadmin14 foreach ($user in $users) { Set-PWUserAdminRights $user -Verbose Set-PWUserWorkingDirectory $user -WorkingFolder("c:\pwwork\pwv8i\" + $user.Name) -Verbose }</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWValidationQRCode --> <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-PWValidationQRCode</command:name> <command:verb>Add</command:verb> <command:noun>PWValidationQRCode</command:noun> <maml:description> <maml:para>Apply a validation QR Code to PDFs in ProjectWise.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Add-PWValidationQRCode</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: QRCodeType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>QRCodeType</maml:name> <maml:description> <maml:para>Override the QRCodeType set for these documents to this.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ForceNativeUnits --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ForceNativeUnits</maml:name> <maml:description> <maml:para>Override the QRCodeType setting and force use of NativeUnits. (Obsolete, ignored).</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: ForceDefaultUnits --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ForceDefaultUnits</maml:name> <maml:description> <maml:para>Override the QRCodeType setting and force use of default units. (Obsolete, ignored).</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: DoNotShortenURL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DoNotShortenURL</maml:name> <maml:description> <maml:para>Do not shorten the URL that gets encoded into the QR Code.</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: StampInForeground --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>StampInForeground</maml:name> <maml:description> <maml:para>By default the QR Code will go in the background where the white will be transparent to existing linework.</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: QRCodeType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>QRCodeType</maml:name> <maml:description> <maml:para>Override the QRCodeType set for these documents to this.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ForceNativeUnits --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ForceNativeUnits</maml:name> <maml:description> <maml:para>Override the QRCodeType setting and force use of NativeUnits. (Obsolete, ignored).</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: ForceDefaultUnits --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ForceDefaultUnits</maml:name> <maml:description> <maml:para>Override the QRCodeType setting and force use of default units. (Obsolete, ignored).</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: DoNotShortenURL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DoNotShortenURL</maml:name> <maml:description> <maml:para>Do not shorten the URL that gets encoded into the QR Code.</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: StampInForeground --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>StampInForeground</maml:name> <maml:description> <maml:para>By default the QR Code will go in the background where the white will be transparent to existing linework.</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:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#This assumes that you have setup the datasource to support QR Code validation using the command "Tools>Set PDF QR Code Parameters". Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder' -FileName %.pdf | Add-PWValidationQRCode</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWValidationQRCodeParameters --> <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-PWValidationQRCodeParameters</command:name> <command:verb>Get</command:verb> <command:noun>PWValidationQRCodeParameters</command:noun> <maml:description> <maml:para>Apply a validation QR Code to PDFs in ProjectWise.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#This assumes that you have setup the datasource to support QR Code validation using the command "Tools>Set PDF QR Code Parameters". Get-PWDocumentsBySearch -FolderPath 'Top Level\Sub-Folder' -FileName %.pdf | Add-PWValidationQRCode</dev:code> </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> <dev:code>#Example usage for getting ProjectWise version. Import-Module pwps_dab Get-PWVersion</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWView --> <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-PWView</command:name> <command:verb>New</command:verb> <command:noun>PWView</command:noun> <maml:description> <maml:para>Create a new view. Use the -Replace flag to replace an existing view. File properties from indexing are not yet supported.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: ViewName --> <command:syntaxItem> <maml:name>New-PWView</maml:name> <!-- Parameter: ViewName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ViewName</maml:name> <maml:description> <maml:para>View 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: Columns --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Columns</maml:name> <maml:description> <maml:para>List of columns to include (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: Environment --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Environment to use as column source (Optional). If not provided, columns that don't resolve to project properties or standard types won't be included in view.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Replace --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>Replace</maml:name> <maml:description> <maml:para>Set this to replace an existing view. Otherwise, if view exists cmdlet will exit.</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: ViewName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ViewName</maml:name> <maml:description> <maml:para>View 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: Columns --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Columns</maml:name> <maml:description> <maml:para>List of columns to include (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: Environment --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Environment to use as column source (Optional). If not provided, columns that don't resolve to project properties or standard types won't be included in view.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Replace --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>Replace</maml:name> <maml:description> <maml:para>Set this to replace an existing view. Otherwise, if view exists cmdlet will exit.</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>View Name (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>List of columns to include (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>Environment to use as column source (Optional). If not provided, columns that don't resolve to project properties or standard types won't be included in view.</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>Set this to replace an existing view. Otherwise, if view exists cmdlet will exit.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWRichProjectProperties Get-PWStandardViewColumns New-PWView "New View 3" -Columns PW_Document_Name,PW_Folder_Name,PROJECT_Budget,PROJECT_End_Date,PROJECT_Project_Name,Interface,A_BIGINT,A_CHAR,A_DOUBLE -Environment "A Test Environment with All Column Types"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Export-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>Export-PWViews</command:name> <command:verb>Export</command:verb> <command:noun>PWViews</command:noun> <maml:description> <maml:para>Export view definitions to a spreadsheet.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: ViewNames --> <command:syntaxItem> <maml:name>Export-PWViews</maml:name> <!-- Parameter: ViewNames --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ViewNames</maml:name> <maml:description> <maml:para>View Names 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> <!-- Parameter: ViewUsers --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ViewUsers</maml:name> <maml:description> <maml:para>Users' views to export (Optional). Only global are exported by default.</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: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ViewNames --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ViewNames</maml:name> <maml:description> <maml:para>View Names 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> <!-- Parameter: ViewUsers --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ViewUsers</maml:name> <maml:description> <maml:para>Users' views to export (Optional). Only global are exported by default.</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: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>View Names to export (Optional).</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>Users' views to export (Optional). Only global are exported by default.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Output file name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Export-PWViews -ViewNames "Default","Drafter" -OutputFileName c:\temp\Views.xlsx $users = Get-PWUsersByMatch * Export-PWViews -ViewUsers $users -OutputFileName c:\temp\Views2.xlsx</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-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>Import-PWViews</command:name> <command:verb>Import</command:verb> <command:noun>PWViews</command:noun> <maml:description> <maml:para>Import views from spreadsheet created by Export-PWViews.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFileName --> <command:syntaxItem> <maml:name>Import-PWViews</maml:name> <!-- Parameter: InputFileName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFileName</maml:name> <maml:description> <maml:para>View 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: OverwriteExistingViews --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>OverwriteExistingViews</maml:name> <maml:description> <maml:para>Set this to replace an existing view. Otherwise, if view exists cmdlet will exit.</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: ViewNames --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>ViewNames</maml:name> <maml:description> <maml:para>View Names 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: InputFileName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFileName</maml:name> <maml:description> <maml:para>View 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: OverwriteExistingViews --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>OverwriteExistingViews</maml:name> <maml:description> <maml:para>Set this to replace an existing view. Otherwise, if view exists cmdlet will exit.</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: ViewNames --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>ViewNames</maml:name> <maml:description> <maml:para>View Names 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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>View Name (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>Set this to replace an existing view. Otherwise, if view exists cmdlet will exit.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>View Names to import (Optional).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Import-PWViews c:\temp\Views.xlsx -ViewNames "Drafter","Manager" -OverwriteExistingViews Import-PWViews c:\temp\Views.xlsx -OverwriteExistingViews</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWWebServiceApiKey --> <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-PWWebServiceApiKey</command:name> <command:verb>Add</command:verb> <command:noun>PWWebServiceApiKey</command:noun> <maml:description> <maml:para>Create an API Key and save a value.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: KeyValue --> <command:syntaxItem> <maml:name>Add-PWWebServiceApiKey</maml:name> <!-- Parameter: KeyValue --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>KeyValue</maml:name> <maml:description> <maml:para>Key Value to encrypt and store. Will often be username:password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Customer --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Customer</maml:name> <maml:description> <maml:para>Want to keep track of Customer.</maml:para> </maml:description> <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="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Application</maml:name> <maml:description> <maml:para>Need application to build hash key.</maml: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: KeyValue --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>KeyValue</maml:name> <maml:description> <maml:para>Key Value to encrypt and store. Will often be username:password.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Customer --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Customer</maml:name> <maml:description> <maml:para>Want to keep track of Customer.</maml:para> </maml:description> <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="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Application</maml:name> <maml:description> <maml:para>Need application to build hash key.</maml: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> <dev:code>Get-PWWebServiceApiKey username:pass</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWWebServiceApiKeyValue --> <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-PWWebServiceApiKeyValue</command:name> <command:verb>Get</command:verb> <command:noun>PWWebServiceApiKeyValue</command:noun> <maml:description> <maml:para>Get the saved value for an API Key.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: ApiKey --> <command:syntaxItem> <maml:name>Get-PWWebServiceApiKeyValue</maml:name> <!-- Parameter: ApiKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>Api Key to return value 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: Application --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Application</maml:name> <maml:description> <maml:para>Api Key is specific to application.</maml: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: ApiKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>Api Key to return value 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: Application --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Application</maml:name> <maml:description> <maml:para>Api Key is specific to application.</maml: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> <dev:code>Get-PWWebServiceApiKeyValue abcdefghi</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWWebServicesGatewayURL --> <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-PWWebServicesGatewayURL</command:name> <command:verb>Set</command:verb> <command:noun>PWWebServicesGatewayURL</command:noun> <maml:description> <maml:para>Set value for Web Services Gateway URL at the datasource level.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Value --> <command:syntaxItem> <maml:name>Set-PWWebServicesGatewayURL</maml:name> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <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: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <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> <dev:code>Set-PWWebServicesGatewayURL https://decide-pwce-sing-ws.bentley.com/ws/v2.8 </dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-PWWebViewURL --> <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-PWWebViewURL</command:name> <command:verb>Set</command:verb> <command:noun>PWWebViewURL</command:noun> <maml:description> <maml:para>Set value for ProjectWise Web View server at the datasource level.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Value --> <command:syntaxItem> <maml:name>Set-PWWebViewURL</maml:name> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <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: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <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> <dev:code>Set-PWWebViewURL https://connect-projectwisewebview.bentley.com/connection/f167a30a7e5b7936e74a2b716210dcdb8cb60871 </dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWWorkAreaConnections --> <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-PWWorkAreaConnections</command:name> <command:verb>Get</command:verb> <command:noun>PWWorkAreaConnections</command:noun> <maml:description> <maml:para>Gets CONNECTED project from a rich project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes an array of ProjectWiseFolders and returns connected project objects.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWWorkAreaConnections</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> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Token</maml:name> <maml:description> <maml:para>Pass base 64 encoded token from Get-PWConnectionClientToken (do not use -UseRelyingParty) or from Get-PWNonFederatedLoginToken -CreateWebToken.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WSGVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>WSGVersion</maml:name> <maml:description> <maml:para>WSG Version. Defaults to v2.5.</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>v2.5</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> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Token</maml:name> <maml:description> <maml:para>Pass base 64 encoded token from Get-PWConnectionClientToken (do not use -UseRelyingParty) or from Get-PWNonFederatedLoginToken -CreateWebToken.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: WSGVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>WSGVersion</maml:name> <maml:description> <maml:para>WSG Version. Defaults to v2.5.</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>v2.5</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> <dev:code>#Example usage for getting the CONNECTED project for each rich project in a tree. $rps = Get-PWRichProjects -FolderPath "PWPS Connected Project Test 6\Projects 2" #foreach rich project, get the Connected Project ID foreach ($rp in $rps) { write-host $rp Get-PWWorkAreaConnections $rp }</dev:code> </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> <dev:code>#Example usage for New-PWWorkflow. #Will return a workflow object for the new workflow in the current datasource. New-PWWorkflow -WorkflowName 'Design' -WorkflowDescription 'Design Workflow'</dev:code> </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> <dev:code>#Example usage for Remove-PWWorkflow. #Will return "true" if the workflow is successfully removed from the current datasource. Remove-PWWorkflow -WorkflowName 'Approved'</dev:code> </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> <maml:description> <maml:para>Clear the workflow on a folder or folders by path or folder ID.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: FolderID --> <command:syntaxItem> <maml:name>Clear-PWWorkflowByFolderPath</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" 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: FolderID --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>FolderID</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: SubFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" 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="false" globbing="false" pipelineInput="true (ByValue)" 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: FolderID --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>FolderID</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: SubFolders --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" 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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$folders=Get-PWFolders -FolderPath 'Top Level\Sub-Folder' foreach ($folder in $folders) {Clear-PWWorkflowByFolderPath $folder.ProjectID}</dev:code> </command:example> </command:examples> </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> <maml:description> <maml:para>Reset the workflow on a folder or folders by path or folder ID.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: FolderID --> <command:syntaxItem> <maml:name>Set-PWWorkflowByFolderPath</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" 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: FolderID --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>FolderID</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: WorkflowName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <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="true (ByValue)" position="3"> <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="true (ByValue)" position="4"> <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="false" globbing="false" pipelineInput="true (ByValue)" 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: FolderID --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>FolderID</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: WorkflowName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <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="true (ByValue)" position="3"> <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="true (ByValue)" position="4"> <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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$folders=Get-PWFolders -FolderPath 'Top Level\Sub-Folder' foreach ($folder in $folders) {Set-PWWorkflowByFolderPath $folder.ProjectID -WorkflowName 'Default Workflow'}</dev:code> </command:example> </command:examples> </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> <dev:code>#Example usage for Get-PWWorkflows. #Will return all workflow objects from current datasource. Get-PWWorkflows</dev:code> </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> <dev:code>#Example usage for Add-PWWorkflowState. #Will return "true" if the state is successfully added to the workflow within the current datasource. Add-PWWorkflowState -Workflow 'Default Workflow' -StateName 'Review' -PreviousStateName 'Draft' -NextStateName 'Pending Approval'</dev:code> </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> <dev:code>#Example usage for Get-PWWorkflowStateLinks. #Will return all state objects that are members of the specified workflow from current datasource. Get-PWWorkflowStateLinks -WorkflowName 'Default Workflow'</dev:code> </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> <dev:code>#Example usage for Remove-PWWorkflowStateLinks. #Will return an updated array of state objects for the specified workflow within the current datasource. Remove-PWWorkflowStateLinks -Workflow 'Default Workflow' -StateName 'Review'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWWorkflowWithStates --> <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-PWWorkflowWithStates</command:name> <command:verb>New</command:verb> <command:noun>PWWorkflowWithStates</command:noun> <maml:description> <maml:para>Creates new workflow and corresponding states in one cmdlet.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: WorkflowName --> <command:syntaxItem> <maml:name>New-PWWorkflowWithStates</maml:name> <!-- Parameter: WorkflowName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkflowName</maml:name> <maml:description> <maml:para>Workflow 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: WorkflowDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>WorkflowDescription</maml:name> <maml:description> <maml:para>Workflow Description (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: States --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>States</maml:name> <maml:description> <maml:para>States to add (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: WorkflowName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>WorkflowName</maml:name> <maml:description> <maml:para>Workflow 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: WorkflowDescription --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>WorkflowDescription</maml:name> <maml:description> <maml:para>Workflow Description (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: States --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>States</maml:name> <maml:description> <maml:para>States to add (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> <dev:code>#Example usage for New-PWWorkflowWithStates. #Will create new workflow give name description and states. New-PWWorkflowWithStates -WorkflowName "New Workflow" -States "Initiate","Work in Progress","Check","Release"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWWorkspaceProfileFromFolder --> <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-PWWorkspaceProfileFromFolder</command:name> <command:verb>Get</command:verb> <command:noun>PWWorkspaceProfileFromFolder</command:noun> <maml:description> <maml:para>Returns the workspace profile associated with a folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Accepts a folder object from the pipeline and returns the associated workspace profile id and name.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Get-PWWorkspaceProfileFromFolder</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Target folder object from pipeline containing sub-folders to remove the Managed Workspace object assocations.</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> </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>Target folder object from pipeline containing sub-folders to remove the Managed Workspace object assocations.</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> </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 from pipeline containing sub-folders to remove the Managed Workspace object assocations.</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 the workspace profile id and name for a folder.</maml:para> <maml:para>Get-PWFolders -FolderPath 'PowerShell' -JustOne | Get-PWWorkspaceProfileFromFolder -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWWorkspaceProfileFromFolder --> <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-PWWorkspaceProfileFromFolder</command:name> <command:verb>Remove</command:verb> <command:noun>PWWorkspaceProfileFromFolder</command:noun> <maml:description> <maml:para>Removes the associated workspace profile from a folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Accepts a folder object from the pipeline and removes the workspace profile associated with it.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputFolder --> <command:syntaxItem> <maml:name>Remove-PWWorkspaceProfileFromFolder</maml:name> <!-- Parameter: InputFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolder</maml:name> <maml:description> <maml:para>Target folder object from pipeline containing sub-folders to remove the Managed Workspace object assocations.</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> </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>Target folder object from pipeline containing sub-folders to remove the Managed Workspace object assocations.</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> </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 from pipeline containing sub-folders to remove the Managed Workspace object assocations.</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 removing a workspace profile from a folder.</maml:para> <maml:para>Get-PWFolders -FolderPath 'PowerShell' -JustOne | Remove-PWWorkspaceProfileFromFolder -Verbose</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWWREActionsForWorkflow --> <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-PWWREActionsForWorkflow</command:name> <command:verb>Get</command:verb> <command:noun>PWWREActionsForWorkflow</command:noun> <maml:description> <maml:para>Get Workflow Rules Engine Actions for a Workflow or Workflow/State.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Workflow --> <command:syntaxItem> <maml:name>Get-PWWREActionsForWorkflow</maml:name> <!-- Parameter: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Workflow to report on (omit for all).</maml:para> </maml:description> <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="1"> <maml:name>State</maml:name> <maml:description> <maml:para>State to report on (omit for all).</maml: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: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Workflow</maml:name> <maml:description> <maml:para>Workflow to report on (omit for all).</maml:para> </maml:description> <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="1"> <maml:name>State</maml:name> <maml:description> <maml:para>State to report on (omit for all).</maml: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>Workflow to report on (omit for all).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWWREActionsForWorkflow 'Workflow A' -State 'Initial'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Test-PWWREActionsWithSuperUser --> <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>Test-PWWREActionsWithSuperUser</command:name> <command:verb>Test</command:verb> <command:noun>PWWREActionsWithSuperUser</command:noun> <maml:description> <maml:para>WRE Rules Validation and Super User Check. Returns true if no issues with SU rules and actions.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Test-PWWREActionsWithSuperUser</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWWREGuardActionToWorkbook --> <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-PWWREGuardActionToWorkbook</command:name> <command:verb>Add</command:verb> <command:noun>PWWREGuardActionToWorkbook</command:noun> <maml:description> <maml:para>Add Super-User Guard Action to WRE Spreadsheet.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFileName --> <command:syntaxItem> <maml:name>Add-PWWREGuardActionToWorkbook</maml:name> <!-- Parameter: InputFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InputFileName</maml:name> <maml:description> <maml:para>Full path to WRE 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: ActionSequence --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ActionSequence</maml:name> <maml:description> <maml:para>Action Sequence (Defaults to 1).</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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <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> <!-- Parameter: AttributeValue --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>AttributeValue</maml:name> <maml:description> <maml:para>Attribute value (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: ClearAttribute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ClearAttribute</maml:name> <maml:description> <maml:para>If not set, will attempt to set attribute to desired value. Set to clear value.</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: NoSuperUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>NoSuperUser</maml:name> <maml:description> <maml:para>If set, will set Super User to false. This action will not be a Guard Action which requires Super User.</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: ActionSequenceFactor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ActionSequenceFactor</maml:name> <maml:description> <maml:para>Value which will be used to multiply the existing action sequence in order to achieve spacing between the sequenced actions. Defaults to 5.</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: OnlySuperUserActionSequences --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>OnlySuperUserActionSequences</maml:name> <maml:description> <maml:para>If set, will only increment action sequences that use the Super User. Otherwise, will increment all action sequences.</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>Full path to WRE 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: ActionSequence --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ActionSequence</maml:name> <maml:description> <maml:para>Action Sequence (Defaults to 1).</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: AttributeName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <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> <!-- Parameter: AttributeValue --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>AttributeValue</maml:name> <maml:description> <maml:para>Attribute value (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: ClearAttribute --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ClearAttribute</maml:name> <maml:description> <maml:para>If not set, will attempt to set attribute to desired value. Set to clear value.</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: NoSuperUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>NoSuperUser</maml:name> <maml:description> <maml:para>If set, will set Super User to false. This action will not be a Guard Action which requires Super User.</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: ActionSequenceFactor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ActionSequenceFactor</maml:name> <maml:description> <maml:para>Value which will be used to multiply the existing action sequence in order to achieve spacing between the sequenced actions. Defaults to 5.</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: OnlySuperUserActionSequences --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>OnlySuperUserActionSequences</maml:name> <maml:description> <maml:para>If set, will only increment action sequences that use the Super User. Otherwise, will increment all action sequences.</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> <dev:code>#Add Guard Action to WRE Spreadsheet. Add-PWWREGuardActionToWorkbook "C:\Users\user.name\Documents\WRE_Export_20200427_Mod.xlsx" -AttributeName GUARD_ATTRIBUTE -AttributeValue YES -ClearAttribute</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWWREOperationType --> <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-PWWREOperationType</command:name> <command:verb>Add</command:verb> <command:noun>PWWREOperationType</command:noun> <maml:description> <maml:para>Add/Update Workflow Rules Engine Operation Types.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: OperationType --> <command:syntaxItem> <maml:name>Add-PWWREOperationType</maml:name> <!-- Parameter: OperationType --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>OperationType</maml:name> <maml:description> <maml:para>Operation Type to add/update. Can be anything, but must be unique. (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: MenuLabel --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>MenuLabel</maml:name> <maml:description> <maml:para>Menu label (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: Prompt --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Prompt</maml:name> <maml:description> <maml:para>Prompt 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: Module --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Module</maml:name> <maml:description> <maml:para>Module name (Required). Should be DavesWREPatch.dll for WRE patching.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Callback --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>Callback</maml:name> <maml:description> <maml:para>Callback function name from Module (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: StateFunction --> <command:parameter required="true" globbing="false" pipelineInput="false" position="5"> <maml:name>StateFunction</maml:name> <maml:description> <maml:para>State function name from Module (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: MenuOrder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="6"> <maml:name>MenuOrder</maml:name> <maml:description> <maml:para>Menu Order (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: OperationType --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>OperationType</maml:name> <maml:description> <maml:para>Operation Type to add/update. Can be anything, but must be unique. (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: MenuLabel --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>MenuLabel</maml:name> <maml:description> <maml:para>Menu label (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: Prompt --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Prompt</maml:name> <maml:description> <maml:para>Prompt 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: Module --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Module</maml:name> <maml:description> <maml:para>Module name (Required). Should be DavesWREPatch.dll for WRE patching.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Callback --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>Callback</maml:name> <maml:description> <maml:para>Callback function name from Module (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: StateFunction --> <command:parameter required="true" globbing="false" pipelineInput="false" position="5"> <maml:name>StateFunction</maml:name> <maml:description> <maml:para>State function name from Module (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: MenuOrder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="6"> <maml:name>MenuOrder</maml:name> <maml:description> <maml:para>Menu Order (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>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Operation Type to add/update. Can be anything, but must be unique. (Required).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Add-PWWREOperationType ADVANCE -MenuLabel "Advance..." -Prompt "Advance?" -Module DavesWREPatch.dll -Callback Exec_DefaultCmd -StateFunction State_DefaultCmd -MenuOrder 1</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWWREOperationTypes --> <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-PWWREOperationTypes</command:name> <command:verb>Get</command:verb> <command:noun>PWWREOperationTypes</command:noun> <maml:description> <maml:para>Get Workflow Rules Engine Operation Types.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWWREOperationTypes</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWWRESuperUsers --> <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-PWWRESuperUsers</command:name> <command:verb>Get</command:verb> <command:noun>PWWRESuperUsers</command:noun> <maml:description> <maml:para>Return Super User and Rollback User for Workflow Rules Engine.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-PWWRESuperUsers | Remove-PWUserFromGroup -GroupName 'Administrator'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWWRESuperUsersFromGroups --> <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-PWWRESuperUsersFromGroups</command:name> <command:verb>Remove</command:verb> <command:noun>PWWRESuperUsersFromGroups</command:noun> <maml:description> <maml:para>Remove WRE Super User and Rollback User from all groups and user lists.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Remove-PWWRESuperUsersFromGroups</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Copy-PWWRETablesBetweenDatasources --> <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-PWWRETablesBetweenDatasources</command:name> <command:verb>Copy</command:verb> <command:noun>PWWRETablesBetweenDatasources</command:noun> <maml:description> <maml:para>Copies a WRE table from one datasource to another datasource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Copies a WRE table from one datasource to another datasource.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Tables --> <command:syntaxItem> <maml:name>Copy-PWWRETablesBetweenDatasources</maml:name> <!-- Parameter: Tables --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Tables</maml:name> <maml:description> <maml:para>Source 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> <!-- Parameter: TargetDatasource --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetDatasource</maml:name> <maml:description> <maml:para>Target datasource 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: SQL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SQL</maml:name> <maml:description> <maml:para>SQL statement 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: TargetTable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>TargetTable</maml:name> <maml:description> <maml:para>Target table for insert (required if using SQL Statement).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReplaceData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ReplaceData</maml:name> <maml:description> <maml:para>Specify to replace existing table data, default is to append.</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: Tables --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Tables</maml:name> <maml:description> <maml:para>Source 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> <!-- Parameter: TargetDatasource --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>TargetDatasource</maml:name> <maml:description> <maml:para>Target datasource 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: SQL --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SQL</maml:name> <maml:description> <maml:para>SQL statement 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: TargetTable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>TargetTable</maml:name> <maml:description> <maml:para>Target table for insert (required if using SQL Statement).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReplaceData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ReplaceData</maml:name> <maml:description> <maml:para>Specify to replace existing table data, default is to append.</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>Source tables.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Copy-PWTablesBetweenDatasources "wre_rule","wre_action","wre_condition","wre_operation_type","wre_rule_action","wre_rule_condition","wre_setting","wre_workflow_operation_type" -TargetDatasource brumd09515rem:importtest2</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-PWWREUserGuardTrigger --> <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-PWWREUserGuardTrigger</command:name> <command:verb>Add</command:verb> <command:noun>PWWREUserGuardTrigger</command:noun> <maml:description> <maml:para>Add trigger TRGNODEL_WRE_SETTINGS to WRE_SETTING table to prevent Super User and Rollback User removal.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Disable-PWWREUserGuardTrigger --> <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>Disable-PWWREUserGuardTrigger</command:name> <command:verb>Disable</command:verb> <command:noun>PWWREUserGuardTrigger</command:noun> <maml:description> <maml:para>Disable trigger TRGNODEL_WRE_SETTINGS on WRE_SETTING table to allow Super User and Rollback User removal.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Enable-PWWREUserGuardTrigger --> <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>Enable-PWWREUserGuardTrigger</command:name> <command:verb>Enable</command:verb> <command:noun>PWWREUserGuardTrigger</command:noun> <maml:description> <maml:para>Enable trigger TRGNODEL_WRE_SETTINGS on WRE_SETTING table to prevent Super User and Rollback User removal.</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Update-PWWREUsers --> <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-PWWREUsers</command:name> <command:verb>Update</command:verb> <command:noun>PWWREUsers</command:noun> <maml:description> <maml:para>Update-PWWREUsers Updates the Workflow Rules Engine Super User and Rollback User names and passwords.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update-PWWREUsers Updates the Workflow Rules Engine Super User and Rollback User names and passwords. These users must already exist in ProjectWise and may not be a member of the Adminstrators or Restricted Administrators grouups. Returns true of all four values are sucessfully set, false otherwise.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-PWWREUsers</maml:name> <!-- Parameter: SUName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SUName</maml:name> <maml:description> <maml:para>Workflow Rules Engine Super 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: SUPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SUPassword</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RUName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>RUName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RUPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>RUPassword</maml:name> <maml:description> <maml:para>Workflow Rules Engine Rollback User Password. Must be secure string.</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: SUName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SUName</maml:name> <maml:description> <maml:para>Workflow Rules Engine Super 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: SUPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>SUPassword</maml:name> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RUName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>RUName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RUPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>RUPassword</maml:name> <maml:description> <maml:para>Workflow Rules Engine Rollback User Password. Must be secure string.</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> <dev:code>Updates the Workflow Rules Engine Super User and RollBack User Passwords. Update-PWWREUsers -SUName "WRESuperUser" -SUPassword SecureString -RUName "WRRollbackUser" -RUPassword SecureString</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Export-PWWREWorkbook --> <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-PWWREWorkbook</command:name> <command:verb>Export</command:verb> <command:noun>PWWREWorkbook</command:noun> <maml:description> <maml:para>Export Rules and Actions from WRE Definition Tables.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: OutputFileName --> <command:syntaxItem> <maml:name>Export-PWWREWorkbook</maml:name> <!-- Parameter: OutputFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Full path to WRE 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: OutputFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>OutputFileName</maml:name> <maml:description> <maml:para>Full path to WRE 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> <dev:code>Export-PWWREWorkbook "C:\Users\user.name\Documents\WRE_Export_20200427_Mod.xlsx"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-PWWREWorkbook --> <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-PWWREWorkbook</command:name> <command:verb>Import</command:verb> <command:noun>PWWREWorkbook</command:noun> <maml:description> <maml:para>Import Rules and Actions from WRE Definition Spreadsheet.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFileName --> <command:syntaxItem> <maml:name>Import-PWWREWorkbook</maml:name> <!-- Parameter: InputFileName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InputFileName</maml:name> <maml:description> <maml:para>Full path to WRE 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>Full path to WRE 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> <dev:code>Import-PWWREWorkbook "C:\Users\user.name\Documents\WRE_Export_20200427_Mod.xlsx"</dev:code> </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> <dev:code>Get-RandomString -Length 10 -Characters "abcdefghijklmnopqrstuvwxyz1234567890"</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-SQLServerStoredProcedure --> <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>Start-SQLServerStoredProcedure</command:name> <command:verb>Start</command:verb> <command:noun>SQLServerStoredProcedure</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Start-SQLServerStoredProcedure</maml:name> <!-- Parameter: ConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>Connection string for SQL database.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StoredProcedure --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>StoredProcedure</maml:name> <maml:description> <maml:para>Stored procedure to trigger main table population.</maml: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: ConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>Connection string for SQL database.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StoredProcedure --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>StoredProcedure</maml:name> <maml:description> <maml:para>Stored procedure to trigger main table population.</maml: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>Connection string for SQL database.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Stored procedure to trigger main table population.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-TablesFromSQLiteDB --> <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-TablesFromSQLiteDB</command:name> <command:verb>Get</command:verb> <command:noun>TablesFromSQLiteDB</command:noun> <maml:description> <maml:para>Imports data from a SQLite Database.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Imports data from a SQLite Database.</maml:para> <maml:para>#SQLiteStudio seems like an adequate managment tool (http://sqlitestudio.pl/?act=download) for the SQLite database container.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-TablesFromSQLiteDB</maml:name> <!-- Parameter: ImportFilePathName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ImportFilePathName</maml:name> <maml:description> <maml:para>SQLite database to import tables from. MUST have the .sqlite 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ImportFilePathName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ImportFilePathName</maml:name> <maml:description> <maml:para>SQLite database to import tables from. MUST have the .sqlite 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> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Imports all data from the specified SQLite database. Get-TablesFromSQLiteDB -ImportFilePathName 'd:\temp\import\ProjectArchive.sqlite' -Verbose</dev:code> </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: InputFileName --> <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> <!-- Parameter: NoHeader --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoHeader</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: 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: NoHeader --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NoHeader</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> <!-- 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> <dev:code>#Read data tables from XLSX Get-TablesFromXLSXWorktook -InputFileName "c:\temp\datatables.xlsx"</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>#Read data tables from XLSX. Do not include headers. Get-TablesFromXLSXWorktook -InputFileName "c:\temp\datatables.xlsx" -NoHeader</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-UnixTimestamp --> <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-UnixTimestamp</command:name> <command:verb>Get</command:verb> <command:noun>UnixTimestamp</command:noun> <maml:description> <maml:para>Get the Unix timestamp for now, UTC now or for a given date string.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Time --> <command:syntaxItem> <maml:name>Get-UnixTimestamp</maml:name> <!-- Parameter: Time --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Time</maml:name> <maml:description> <maml:para>Date Time string to parse.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UTC --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>UTC</maml:name> <maml:description> <maml:para>Use 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: Nanoseconds --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Nanoseconds</maml:name> <maml:description> <maml:para>Use 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: UTC --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>UTC</maml:name> <maml:description> <maml:para>Use 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: Nanoseconds --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Nanoseconds</maml:name> <maml:description> <maml:para>Use 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: Time --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Time</maml:name> <maml:description> <maml:para>Date Time string to parse.</maml: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.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Use UTC.</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>Use UTC.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Date Time string to parse.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-UnixTimestamp -UTC -Nanoseconds</dev:code> </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> <!-- Parameter: PreserveLinksInExistingWorkbook --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>PreserveLinksInExistingWorkbook</maml:name> <maml:description> <maml:para>Preserve the ProjectWise links in an existing workbook. Has big performance implications for adding to existing workbooks.</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> <!-- Parameter: PreserveLinksInExistingWorkbook --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>PreserveLinksInExistingWorkbook</maml:name> <maml:description> <maml:para>Preserve the ProjectWise links in an existing workbook. Has big performance implications for adding to existing workbooks.</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> <dev:code>#Get a report of documents in the given folder tree and output to XLSX directly Get-PWDocumentReportDataTable -ProjectWiseFolder "PWPS\Projects 2\Project A" -Recurse -IncludeAuditTrail | New-XLSXWorkbook -OutputFileName c:\temp\tables.xlsx</dev:code> </command:example> </command:examples> </command:command> </helpItems> |