dbc_pwps

1.0.0

en-US/DBC_PWPS.dll-Help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh">
  <!-- Cmdlet: Update-PWDocumentFilesFromArchiveByChecksum -->
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns: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-PWDocumentFilesFromArchiveByChecksum</command:name>
      <command:verb>Update</command:verb>
      <command:noun>PWDocumentFilesFromArchiveByChecksum</command:noun>
      <maml:description>
        <maml:para>Updates PW document files from the files contained in a SQLite archive container by comparing checksums between the file in ProjectWise vs. the file in 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-PWDocumentFilesFromArchiveByChecksum</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>Path to SQLLite file to import from. Will not look for it in local folder 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: 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 checksum 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>
      </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>Path to SQLLite file to import from. Will not look for it in local folder 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: 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 checksum 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>
    </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"
Update-PWDocumentsFromArchiveByChecksum -InputFile 'c:\export\export.sqlite' -InputDocuments $doc -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>
</helpItems>