en-US/DBC_PWPS.dll-Help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-ADSKPlatformServicesToken --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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-ADSKPlatformServicesToken</command:name> <command:verb>Get</command:verb> <command:noun>ADSKPlatformServicesToken</command:noun> <maml:description> <maml:para>Get an ADSK Platform Services token.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ADSKPlatformServicesToken</maml:name> <!-- Parameter: Scopes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Scopes</maml:name> <maml:description> <maml:para>Access Scopes. Defaults to "data:read data:write data:create"</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>data:read data:write data:create</dev:defaultValue> </command:parameter> <!-- Parameter: ClientID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ClientID</maml:name> <maml:description> <maml:para>ClientID. Defaults to "skjsDFAIgCGHs7hp1pHxtWosVHkBRWLcsyyeAwI0LxWucqM0"</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>skjsDFAIgCGHs7hp1pHxtWosVHkBRWLcsyyeAwI0LxWucqM0</dev:defaultValue> </command:parameter> <!-- Parameter: ForceError --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>ForceError</maml:name> <maml:description> <maml:para>For testing unattended scripts.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ClientSecret --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>ClientSecret</maml:name> <maml:description> <maml:para>ClientSecret. Defaults to "cMirevRWRNhaEtoQvCAa4ebZnklR0VjRg6VeghMXVWKcsW0RJ5DxRhaP9hwhbmoY"</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>cMirevRWRNhaEtoQvCAa4ebZnklR0VjRg6VeghMXVWKcsW0RJ5DxRhaP9hwhbmoY</dev:defaultValue> </command:parameter> <!-- Parameter: RedirectCallback --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>RedirectCallback</maml:name> <maml:description> <maml:para>Defaults to http://localhost:8055/. Needs to match the Redirect URL as defined in the app definition.</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>http://localhost:8055/</dev:defaultValue> </command:parameter> <!-- Parameter: UseWebPage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>UseWebPage</maml:name> <maml:description> <maml:para>Use web page instead of built-in dialog.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UseCacheIfAvailable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>UseCacheIfAvailable</maml:name> <maml:description> <maml:para>Use cached token if available.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NewToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>NewToken</maml:name> <maml:description> <maml:para>Bypass values cached in registry and force new token generation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SuppressLoginPrompt --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>SuppressLoginPrompt</maml:name> <maml:description> <maml:para>Changes the login address.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UnattendedMode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>UnattendedMode</maml:name> <maml:description> <maml:para>Suppresses interactive form and throws exception on failure.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PreserveRegistryValues --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>PreserveRegistryValues</maml:name> <maml:description> <maml:para>Don't overwrite registry entries when refresh 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: Scopes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Scopes</maml:name> <maml:description> <maml:para>Access Scopes. Defaults to "data:read data:write data:create"</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>data:read data:write data:create</dev:defaultValue> </command:parameter> <!-- Parameter: ClientID --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ClientID</maml:name> <maml:description> <maml:para>ClientID. Defaults to "skjsDFAIgCGHs7hp1pHxtWosVHkBRWLcsyyeAwI0LxWucqM0"</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>skjsDFAIgCGHs7hp1pHxtWosVHkBRWLcsyyeAwI0LxWucqM0</dev:defaultValue> </command:parameter> <!-- Parameter: ClientSecret --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>ClientSecret</maml:name> <maml:description> <maml:para>ClientSecret. Defaults to "cMirevRWRNhaEtoQvCAa4ebZnklR0VjRg6VeghMXVWKcsW0RJ5DxRhaP9hwhbmoY"</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>cMirevRWRNhaEtoQvCAa4ebZnklR0VjRg6VeghMXVWKcsW0RJ5DxRhaP9hwhbmoY</dev:defaultValue> </command:parameter> <!-- Parameter: RedirectCallback --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>RedirectCallback</maml:name> <maml:description> <maml:para>Defaults to http://localhost:8055/. Needs to match the Redirect URL as defined in the app definition.</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>http://localhost:8055/</dev:defaultValue> </command:parameter> <!-- Parameter: UseWebPage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>UseWebPage</maml:name> <maml:description> <maml:para>Use web page instead of built-in dialog.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: UseCacheIfAvailable --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>UseCacheIfAvailable</maml:name> <maml:description> <maml:para>Use cached token if available.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: NewToken --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>NewToken</maml:name> <maml:description> <maml:para>Bypass values cached in registry and force new token generation.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SuppressLoginPrompt --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>SuppressLoginPrompt</maml:name> <maml:description> <maml:para>Changes the login address.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: UnattendedMode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>UnattendedMode</maml:name> <maml:description> <maml:para>Suppresses interactive form and throws exception on failure.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PreserveRegistryValues --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>PreserveRegistryValues</maml:name> <maml:description> <maml:para>Don't overwrite registry entries when refresh 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: ForceError --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>ForceError</maml:name> <maml:description> <maml:para>For testing unattended scripts.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</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-ADSKPlatformServicesToken -ClientID 'native-j9uh78Bv6S8fITCRxHkXdYaos' -RedirectCallback 'http://localhost:8055' -Scopes 'data:read data:write data:create' -ClientSecret 'XXXX'</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWDMTransmittalClassifications --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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-PWDMTransmittalClassifications</command:name> <command:verb>Get</command:verb> <command:noun>PWDMTransmittalClassifications</command:noun> <maml:description> <maml:para>For Deliverables Management Connector v 10.7.0.131 (tested), get transmittal classifications from project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: ConnectedProjectId --> <command:syntaxItem> <maml:name>Get-PWDMTransmittalClassifications</maml:name> <!-- Parameter: ConnectedProjectId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>CONNECTed Project to query for Purposes.</maml:para> </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="false" position="1"> <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:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ConnectedProjectId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>CONNECTed Project to query for Purposes.</maml:para> </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="false" position="1"> <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:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$folder = Get-PWFolderByURN 'pw://dsn-pw.bentley.com:dsn/Documents/P{daefc2b9-e348-441c-8c3e-2406c5e1e0ec}/' $token = Get-PWConnectionClientToken Get-PWDMTransmittalClassifications -ConnectedProjectId $folder.ConnectedProjectId -ConnectToken $token</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-PWDMTransmittalDBC --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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-PWDMTransmittalDBC</command:name> <command:verb>New</command:verb> <command:noun>PWDMTransmittalDBC</command:noun> <maml:description> <maml:para>For Deliverables Management Connector v 10.7.0.131 (tested), create a transmittal given ConnectedProjectId, Transmittal Name and files.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputDocument --> <command:syntaxItem> <maml:name>New-PWDMTransmittalDBC</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>Issue Transmittal</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</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: Confidential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>Confidential</maml:name> <maml:description> <maml:para>Comment to include with new transmittal.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Purpose --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>Purpose</maml:name> <maml:description> <maml:para>Transmittal purpose.</maml:para> </maml: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="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: Confidential --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>Confidential</maml:name> <maml:description> <maml:para>Comment to include with new transmittal.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Purpose --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>Purpose</maml:name> <maml:description> <maml:para>Transmittal purpose.</maml:para> </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>Issue Transmittal</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</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>$folder = Get-PWFolderByURN 'pw://dsn-pw.bentley.com:dsn/Documents/P{daefc2b9-e348-441c-8c3e-2406c5e1e0ec}/' $docs = Get-PWDocumentsBySearch -FolderID $folder.ProjectID -FileName %.pdf $token = Get-PWConnectionClientToken New-PWDMTransmittalDBC $docs -ConnectedProjectId $folder.ConnectedProjectId -TransmittalName "New transmittal 07E" -SendToEmails "dave@davebrumbaugh.com","dave.brumbaugh@gmail.com" -TransmittalComment "A comment on this" -Classification "Some classification" -ConnectToken $token</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWDMTransmittalPurposes --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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-PWDMTransmittalPurposes</command:name> <command:verb>Get</command:verb> <command:noun>PWDMTransmittalPurposes</command:noun> <maml:description> <maml:para>For Deliverables Management Connector v 10.7.0.131 (tested), get transmittal purposes from project.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: ConnectedProjectId --> <command:syntaxItem> <maml:name>Get-PWDMTransmittalPurposes</maml:name> <!-- Parameter: ConnectedProjectId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>CONNECTed Project to query for Purposes.</maml:para> </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="false" position="1"> <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:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ConnectedProjectId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ConnectedProjectId</maml:name> <maml:description> <maml:para>CONNECTed Project to query for Purposes.</maml:para> </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="false" position="1"> <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:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$folder = Get-PWFolderByURN 'pw://dsn-pw.bentley.com:dsn/Documents/P{daefc2b9-e348-441c-8c3e-2406c5e1e0ec}/' $token = Get-PWConnectionClientToken Get-PWDMTransmittalPurposes -ConnectedProjectId $folder.ConnectedProjectId -ConnectToken $token</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-PWDocumentFilesFromArchive --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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-PWDocumentFilesFromArchive</command:name> <command:verb>Update</command:verb> <command:noun>PWDocumentFilesFromArchive</command:noun> <maml:description> <maml:para>Updates PW document files from the files contained in a SQLite archive container by comparing sizes between the file in ProjectWise vs. the file extracted from the archive.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update files from a SQLite archive container.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Update-PWDocumentFilesFromArchive</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 (optional). 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: InputFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>InputFile</maml:name> <maml:description> <maml:para>Full path to SQLLite file 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="2"> <maml:name>TargetProjectWiseFolder</maml:name> <maml:description> <maml:para>New parent folder used for 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: LocalFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>LocalFolder</maml:name> <maml:description> <maml:para>Local working folder for file copy out/creation.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReplaceFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ReplaceFiles</maml:name> <maml:description> <maml:para>If file exists in ProjectWise and the size from the file in the archive does not match, replace 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> <!-- Parameter: OutputFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>Full path to XLXS report file for reporting. Will end up in temporary folder otherwise.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RemoveFilesFirst --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>RemoveFilesFirst</maml:name> <maml:description> <maml:para>Remove file from the document first before replacing.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PreserveExtractedFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>PreserveExtractedFiles</maml:name> <maml:description> <maml:para>Preserve the mismatched files extracted from the archive in LocalFolder.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</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 (optional). 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: InputFile --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>InputFile</maml:name> <maml:description> <maml:para>Full path to SQLLite file 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="2"> <maml:name>TargetProjectWiseFolder</maml:name> <maml:description> <maml:para>New parent folder used for 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: LocalFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>LocalFolder</maml:name> <maml:description> <maml:para>Local working folder for file copy out/creation.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReplaceFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ReplaceFiles</maml:name> <maml:description> <maml:para>If file exists in ProjectWise and the size from the file in the archive does not match, replace 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> <!-- Parameter: OutputFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>Full path to XLXS report file for reporting. Will end up in temporary folder otherwise.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RemoveFilesFirst --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>RemoveFilesFirst</maml:name> <maml:description> <maml:para>Remove file from the document first before replacing.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PreserveExtractedFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>PreserveExtractedFiles</maml:name> <maml:description> <maml:para>Preserve the mismatched files extracted from the archive in LocalFolder.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</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 (optional). 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>#Will update document files from an archive container. $docs = Get-PWDocumentsBySearch -SearchName "DGNs in Current Project" -PopulatePaths Update-PWDocumentFilesFromArchive $docs -InputFile 'c:\export\export.sqlite' -ReplaceFiles</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWFileHashValue --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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-PWFileHashValue</command:name> <command:verb>Get</command:verb> <command:noun>PWFileHashValue</command:noun> </command:details> <command:syntax> <!-- Parameter set: InputDocuments --> <command:syntaxItem> <maml:name>Get-PWFileHashValue</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> <!-- Parameter: SaveFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SaveFile</maml:name> <maml:description> <maml:para>Set to save the file. Default is to delete after determining Hash 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> </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> <!-- Parameter: SaveFile --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SaveFile</maml:name> <maml:description> <maml:para>Set to save the file. Default is to delete after determining Hash 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> </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: Move-PWFolderPathToNewStorage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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-PWFolderPathToNewStorage</command:name> <command:verb>Move</command:verb> <command:noun>PWFolderPathToNewStorage</command:noun> <maml:description> <maml:para>The Move-PWFolderPathToNewStorage cmdlet allows you to move a project with all sub-folders and documents to another storage area.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Allows you to move a project with all sub-folders and documents to another storage area.</maml:para> <maml:para>Note that this actually recreates the source folder on the new storage area and then moves the files over from the old storage.</maml:para> <maml:para>As a result, this can be a time consuming operation for a dense folder tree. Can also lead to extra records in the audit trail.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: FolderPath --> <command:syntaxItem> <maml:name>Move-PWFolderPathToNewStorage</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:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Move the folder tree in 'Folders\Created in Old Storage' to the BlobStorage storage area. Move-PWFolderPathToNewStorage -FolderPath "Folders\Created in Old Storage" -TargetStorage BlobStorage</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Export-PWManagedWorkspace --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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-PWManagedWorkspace</command:name> <command:verb>Export</command:verb> <command:noun>PWManagedWorkspace</command:noun> <maml:description> <maml:para>Export the managed workspace configuration settings blocks for individual projects, or for the whole datasource.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolders --> <command:syntaxItem> <maml:name>Export-PWManagedWorkspace</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: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <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: IncludeInherited --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>IncludeInherited</maml:name> <maml:description> <maml:para>Gets inherited CSBs.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ExportFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ExportFiles</maml:name> <maml:description> <maml:para>Export files in addition to report.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ExportDirectory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ExportDirectory</maml:name> <maml:description> <maml:para>Where to store exported 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: ZipArchiveName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>ZipArchiveName</maml:name> <maml:description> <maml:para>Zip report and exported files into this file. Suitable for use by Import-PWManagedWorkspace.</maml:para> </maml: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: OutputFileName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <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: IncludeInherited --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>IncludeInherited</maml:name> <maml:description> <maml:para>Gets inherited CSBs.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ExportFiles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ExportFiles</maml:name> <maml:description> <maml:para>Export files in addition to report.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ExportDirectory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ExportDirectory</maml:name> <maml:description> <maml:para>Where to store exported 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: ZipArchiveName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>ZipArchiveName</maml:name> <maml:description> <maml:para>Zip report and exported files into this file. Suitable for use by Import-PWManagedWorkspace.</maml:para> </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:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Output file name for report.</maml:para> </maml:description> </command:inputType> </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>#for a folder tree Get-PWFolders -FolderPath 'Top Level\Sub-Folder' -JustOne | Export-PWManagedWorkspace -IncludeInherited #for the whole datasource $report = Export-PWManagedWorkspace -ExportFiles -ExportDirectory c:\temp\wsbackup5 -ZipArchiveName SaveFiles00.zip</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-PWManagedWorkspace --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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-PWManagedWorkspace</command:name> <command:verb>Import</command:verb> <command:noun>PWManagedWorkspace</command:noun> <maml:description> <maml:para>Imports CSBs, variables and files contained in an archive or report exported by Export-PWManagedWorkspace.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: ImportFileName --> <command:syntaxItem> <maml:name>Import-PWManagedWorkspace</maml:name> <!-- Parameter: ImportFileName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ImportFileName</maml:name> <maml:description> <maml:para>Import archive 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: StorageArea --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>StorageArea</maml:name> <maml:description> <maml:para>Storage area in which to create 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: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <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: Environment --> <command:parameter required="false" globbing="false" pipelineInput="false" 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: Overwrite --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrite existing CSBs and variables.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: State --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>State</maml:name> <maml:description> <maml:para>Workflow 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> <!-- Parameter: WorkingDirectory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>WorkingDirectory</maml:name> <maml:description> <maml:para>Where to store exported 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: Prefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Prefix</maml:name> <maml:description> <maml:para>Where to store exported 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> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ImportFileName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ImportFileName</maml:name> <maml:description> <maml:para>Import archive 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: StorageArea --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>StorageArea</maml:name> <maml:description> <maml:para>Storage area in which to create 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: Workflow --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <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: Environment --> <command:parameter required="false" globbing="false" pipelineInput="false" 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: State --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>State</maml:name> <maml:description> <maml:para>Workflow 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> <!-- Parameter: Overwrite --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrite existing CSBs and variables.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: WorkingDirectory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>WorkingDirectory</maml:name> <maml:description> <maml:para>Where to store exported 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: Prefix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Prefix</maml:name> <maml:description> <maml:para>Where to store exported 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> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Import archive file name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Can use the zip file created in Export-PWManagedWorkspace Import-PWManagedWorkspace c:\temp\SaveFiles00.zip -StorageArea Storage -Environment Env_1 -Workflow Workflow_1 -State State_1 -Overwrite -WorkingDirectory G:\Temp #Alternatively, can use the XLSX report created in Export-PWManagedWorkspace Import-PWManagedWorkspace c:\temp\2024-06-11_abcdzu.xlsx -StorageArea Storage -Environment Env_1 -Workflow Workflow_1 -State State_1 -Overwrite -WorkingDirectory G:\Temp</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-PWManagedWorkspace --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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-PWManagedWorkspace</command:name> <command:verb>Remove</command:verb> <command:noun>PWManagedWorkspace</command:noun> <maml:description> <maml:para>Removes CSBs from datasource.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: CSBNames --> <command:syntaxItem> <maml:name>Remove-PWManagedWorkspace</maml:name> <!-- Parameter: CSBNames --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>CSBNames</maml:name> <maml:description> <maml:para>CSB Names to remove (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: RemoveAll --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RemoveAll</maml:name> <maml:description> <maml:para>Remove all the CSBs.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: CSBLevels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>CSBLevels</maml:name> <maml:description> <maml:para>Remove all CSBs at this level (optional): "Global", "Application", "Customer", "Site", "Project", "Discipline", "User", "User_Private", "Predefined", "Workspace".</maml:para> </maml: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: CSBNames --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>CSBNames</maml:name> <maml:description> <maml:para>CSB Names to remove (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: RemoveAll --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RemoveAll</maml:name> <maml:description> <maml:para>Remove all the CSBs.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: CSBLevels --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>CSBLevels</maml:name> <maml:description> <maml:para>Remove all CSBs at this level (optional): "Global", "Application", "Customer", "Site", "Project", "Discipline", "User", "User_Private", "Predefined", "Workspace".</maml:para> </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>CSB Names to remove (optional).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Delete specific CSBs Remove-PWManagedWorkspace -CSBNames OOB_OpenBuildingsDesigner_DynDataset_CE,OOB_OpenBuildingsDesigner_WKST_CE,OOB_OpenBuildingsDesigner_WorksetLink_CE,OOB_Substation_WorkSet_Link_CE #Alternatively, can remove all Remove-PWManagedWorkspace -RemoveAll</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-PWManagedWorkspaceAssocId --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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-PWManagedWorkspaceAssocId</command:name> <command:verb>Get</command:verb> <command:noun>PWManagedWorkspaceAssocId</command:noun> <maml:description> <maml:para>Removes CSBs from datasource.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: InputFolders --> <command:syntaxItem> <maml:name>Get-PWManagedWorkspaceAssocId</maml:name> <!-- Parameter: InputFolders --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputFolders</maml:name> <maml:description> <maml:para>CSB Names to remove (optional).</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[PWPS_DAB.CommonTypes+ProjectWiseFolder, PWPS_DAB, Version=23.4.1.0, Culture=neutral, PublicKeyToken=null]]</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>CSB Names to remove (optional).</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[PWPS_DAB.CommonTypes+ProjectWiseFolder, PWPS_DAB, Version=23.4.1.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.List`1[[PWPS_DAB.CommonTypes+ProjectWiseFolder, PWPS_DAB, Version=23.4.1.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>CSB Names to remove (optional).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>#Delete specific CSBs Remove-PWManagedWorkspace -CSBNames OOB_OpenBuildingsDesigner_DynDataset_CE,OOB_OpenBuildingsDesigner_WKST_CE,OOB_OpenBuildingsDesigner_WorksetLink_CE,OOB_Substation_WorkSet_Link_CE #Alternatively, can remove all Remove-PWManagedWorkspace -RemoveAll</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-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>Get-PWSQL</command:name> <command:verb>Get</command:verb> <command:noun>PWSQL</command:noun> </command:details> <command:syntax> <!-- Parameter set: SQLSelectStatement --> <command:syntaxItem> <maml:name>Get-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:command> <!-- Cmdlet: Compare-PWToLocal --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Compare-PWToLocal</command:name> <command:verb>Compare</command:verb> <command:noun>PWToLocal</command:noun> <maml:description> <maml:para>Compares PW folder contents to disk folder contents.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Compares PW folder contents to disk folder contents.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: PWFolderPath --> <command:syntaxItem> <maml:name>Compare-PWToLocal</maml:name> <!-- Parameter: PWFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>PWFolderPath</maml:name> <maml:description> <maml:para>Path of folder to compare.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocalFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>LocalFolder</maml:name> <maml:description> <maml:para>Local disk folder to compare.</maml:para> </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>Full path to XLXS report file for reporting. Will end up in temporary folder otherwise.</maml:para> </maml: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: PWFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>PWFolderPath</maml:name> <maml:description> <maml:para>Path of folder to compare.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocalFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>LocalFolder</maml:name> <maml:description> <maml:para>Local disk folder to compare.</maml:para> </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>Full path to XLXS report file for reporting. Will end up in temporary folder otherwise.</maml:para> </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 comparison report. Compare-PWToLocal "DBC_PWPS_TEST\Test 01\Designs" -LocalFolder F:\d_copy\Company\Designs -OutputFile c:\temp\Compare10.xlsx #This had been the previous import step using pwps_dab. $importDocs = Import-PWDocuments -InputFolder F:\d_copy\Company\Designs -ProjectWiseFolder "DBC_PWPS_TEST\Test 01\Designs" -DefaultStorage azblob -ExcludeSourceDirectoryFromTargetPath</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Compare-PWToPW --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Compare-PWToPW</command:name> <command:verb>Compare</command:verb> <command:noun>PWToPW</command:noun> <maml:description> <maml:para>Compares PW folder contents in one datasource to another datasource.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Compares PW folder contents in one datasource to another datasource.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: PWFolderPath --> <command:syntaxItem> <maml:name>Compare-PWToPW</maml:name> <!-- Parameter: PWFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>PWFolderPath</maml:name> <maml:description> <maml:para>Folder path to compare.</maml:para> </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 for comparison.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>TargetFolder</maml:name> <maml:description> <maml:para>Target folder for comparison.</maml:para> </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="3"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>Full path to XLXS report file for reporting. Will end up in temporary folder otherwise.</maml:para> </maml: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: PWFolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>PWFolderPath</maml:name> <maml:description> <maml:para>Folder path to compare.</maml:para> </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 for comparison.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TargetFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>TargetFolder</maml:name> <maml:description> <maml:para>Target folder for comparison.</maml:para> </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="3"> <maml:name>OutputFile</maml:name> <maml:description> <maml:para>Full path to XLXS report file for reporting. Will end up in temporary folder otherwise.</maml:para> </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 comparison report. Compare-PWToPW "DBC_PWPS_TEST\Test 01\Designs" -TargetDatasource server:dsn -TargetFolder "Some Other\Path" -OutputFile c:\temp\Compare10.xlsx #This had been the previous copy step using pwps_dab. $folder = Get-PWFolderByURN "pw://server1:pw2023/Documents/P{aab4e657-708d-46ff-a8c1-6fd8047c9cf6}/" Copy-PWFoldersBetweenDatasources -InputFolders $folder -TargetDatasource server:dsn -TargetParentPath "Some Other\Path" -TargetStorage BlobStorage -IgnoreMissingEnvironments -IgnoreMissingWorkflows -IgnoreMissingViews -IgnoreMissingProjectTypes -IncludeDocuments</dev:code> </command:example> </command:examples> </command:command> </helpItems> |