en-US/PoshCommence.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-CmcControlCharacters</command:name> <command:verb>Clear</command:verb> <command:noun>CmcControlCharacters</command:noun> <maml:description> <maml:para>Clears control characters from Commence category items. USE WITH CAUTION.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Commence allows for entering control characters in fields where there should be none. This can cause issues in various scenarios. This cmdlet clears or changes any control characters from fields which should not contain them. This cmdlet makes changes to the Commence database so take appropriate precautions to prevent potential data loss. It is strongly recommended that you start the Commence application with the /noagents command line parameter prior to running this cmdlet, or Commence may lock up and crash.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-CmcControlCharacters</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="c"> <maml:name>CategoryName</maml:name> <maml:description> <maml:para>Commence category name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="l"> <maml:name>LogDir</maml:name> <maml:description> <maml:para>Directory to write logfile to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ColumnDelimiter</maml:name> <maml:description> <maml:para>Do not touch this unless you are a true Commence wizard. It is the delimiter passed to a RowSet's `GetRow()` method. You only ever need to change this if the default for some reason gives unwanted results. The default is defined in Vovin.CmcLibNet (https://github.com/arnovb-github/CmcLibNet).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overrides confirmation of running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="m"> <maml:name>MaxRows</maml:name> <maml:description> <maml:para>Number of Commence database rows to process at a time. Defaults to 100. Change this to 1 if an error occurs and you need to pinpoint the exact item that raised the error. There is a significant performance penalty when lowering this.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Writes proposed changes to the log file but does not actually make changes to the database.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="c"> <maml:name>CategoryName</maml:name> <maml:description> <maml:para>Commence category name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ColumnDelimiter</maml:name> <maml:description> <maml:para>Do not touch this unless you are a true Commence wizard. It is the delimiter passed to a RowSet's `GetRow()` method. You only ever need to change this if the default for some reason gives unwanted results. The default is defined in Vovin.CmcLibNet (https://github.com/arnovb-github/CmcLibNet).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overrides confirmation of running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="l"> <maml:name>LogDir</maml:name> <maml:description> <maml:para>Directory to write logfile to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="m"> <maml:name>MaxRows</maml:name> <maml:description> <maml:para>Number of Commence database rows to process at a time. Defaults to 100. Change this to 1 if an error occurs and you need to pinpoint the exact item that raised the error. There is a significant performance penalty when lowering this.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Writes proposed changes to the log file but does not actually make changes to the database.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Some Commence fields will accept control characters when they should not. They can either be entered directly in the UI, copy/pasted, or written by the API. Depending on the fieldtype, this can cause unwanted side-effects, ranging from simply not being able to call a URL containing an unexpected CR/LF in it to Commence crashing on enrolls. This cmdlet will strip control characters from text-based fields. Tabs are replaced with spaces. Line endings and carriage returns are either removed completely or replaced with Windows line-endings.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Clear-CmcControlCharacters Account</dev:code> <dev:remarks> <maml:para>(Simplest, but see example 2) Will prompt user to remove control characters from fields in category 'Account'. A log will be written to '%AppData%\Local\PoshCommence'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Clear-CmcControlCharacters -CategoryName Account -WhatIf -LogDir C:\TEMP</dev:code> <dev:remarks> <maml:para>(Recommended usage upon first run) Will do a dummy run on category 'Account' and write suggested changes to a log file in 'C:\TEMP'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Clear-CmcControlCharacters -CategoryName Account -WhatIf -LogDir C:\TEMP Clear-CmcControlCharacters -CategoryName Account -LogDir C:\TEMP</dev:code> <dev:remarks> <maml:para>Recommended usage. The first command will do a dry run. A logfile of pending changes will be written to 'C:\TEMP' in Json format. If you are satisfied with the changes, run the second command.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-CmcCategories | Clear-CmcControlCharacters -WhatIf -LogDir C:\TEMP</dev:code> <dev:remarks> <maml:para>Analyze all categories in the database by piping them to the cmdlet. A logfile of pending changes will be written to 'C:\TEMP' in Json format.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Get-CmcCategories | Clear-CmcControlCharacters -LogDir C:\TEMP -Force</dev:code> <dev:remarks> <maml:para>If you are absolutely certain you want to clean up all categories, pass in all category names and override any confirmation.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <dev:code>Clear-CmcControlCharacters -CategoryName Account -ColumnDelimiter 'vErYbAD' -Force</dev:code> <dev:remarks> <maml:para>EXPERTS ONLY. The 'ColumnDelimiter' parameter is not some casual CSV thingie, it is used to tell columns apart in a Commence database query. It is very unlikely that anyone should ever have to use the `ColumnDelimiter` parameter, I may in fact remove this option in future versions.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-CmcMetadataCache</command:name> <command:verb>Clear</command:verb> <command:noun>CmcMetadataCache</command:noun> <maml:description> <maml:para>Reset Commence metadata cache.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Will reset the cache holding Commence schema information that is being built up as you use this module. Use this cmdlet when the Commence database schema has changed, for example when a field was added.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-CmcMetadataCache</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>When you switch databases, the cache is automatically cleared.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Clear-CmcMetadataCache</dev:code> <dev:remarks> <maml:para>Will clear the cache holding Commence schema information.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-CmcData</command:name> <command:verb>Export</command:verb> <command:noun>CmcData</command:noun> <maml:description> <maml:para>Export Commence data to file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Exports Commence data to file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-CmcData</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="c"> <maml:name>CategoryName</maml:name> <maml:description> <maml:para>Commence category name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="o"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Path and filename to export to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ConnectedFields</maml:name> <maml:description> <maml:para>Fields from connections.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConnectedField[]</command:parameterValue> <dev:type> <maml:name>ConnectedField[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExportFormat</maml:name> <maml:description> <maml:para>File format to export to.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Xml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Html</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Text</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Excel</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GoogleSheets</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Event</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ExportFormat</command:parameterValue> <dev:type> <maml:name>ExportFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FieldNames</maml:name> <maml:description> <maml:para>Array of fieldnames to include in the export.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filters</maml:name> <maml:description> <maml:para>List of filters to apply to the category.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ICursorFilter[]</command:parameterValue> <dev:type> <maml:name>ICursorFilter[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreserveAllConnections</maml:name> <maml:description> <maml:para>Makes sure all connected items are returned. Comes at a significant performance penalty. Only use it when you have tens of thousands of connected items.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipConnectedItems</maml:name> <maml:description> <maml:para>Will prevent the export enginhe reading connected data.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UseThids</maml:name> <maml:description> <maml:para>Include THIDs.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Export-CmcData</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="v"> <maml:name>ViewName</maml:name> <maml:description> <maml:para>Commence view name (case-sensitive!).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="o"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Path and filename to export to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExportFormat</maml:name> <maml:description> <maml:para>File format to export to.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Xml</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Html</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Text</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Excel</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GoogleSheets</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Event</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ExportFormat</command:parameterValue> <dev:type> <maml:name>ExportFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreserveAllConnections</maml:name> <maml:description> <maml:para>Makes sure all connected items are returned. Comes at a significant performance penalty. Only use it when you have tens of thousands of connected items.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipConnectedItems</maml:name> <maml:description> <maml:para>Will prevent the export enginhe reading connected data.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UseColumnNames</maml:name> <maml:description> <maml:para>Use the columnlabel as node/key/column header instead of the Commence fieldname.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="c"> <maml:name>CategoryName</maml:name> <maml:description> <maml:para>Commence category name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ConnectedFields</maml:name> <maml:description> <maml:para>Fields from connections.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConnectedField[]</command:parameterValue> <dev:type> <maml:name>ConnectedField[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ExportFormat</maml:name> <maml:description> <maml:para>File format to export to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ExportFormat</command:parameterValue> <dev:type> <maml:name>ExportFormat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FieldNames</maml:name> <maml:description> <maml:para>Array of fieldnames to include in the export.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filters</maml:name> <maml:description> <maml:para>List of filters to apply to the category.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ICursorFilter[]</command:parameterValue> <dev:type> <maml:name>ICursorFilter[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="o"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Path and filename to export to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreserveAllConnections</maml:name> <maml:description> <maml:para>Makes sure all connected items are returned. Comes at a significant performance penalty. Only use it when you have tens of thousands of connected items.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipConnectedItems</maml:name> <maml:description> <maml:para>Will prevent the export enginhe reading connected data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UseColumnNames</maml:name> <maml:description> <maml:para>Use the columnlabel as node/key/column header instead of the Commence fieldname.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UseThids</maml:name> <maml:description> <maml:para>Include THIDs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="v"> <maml:name>ViewName</maml:name> <maml:description> <maml:para>Commence view name (case-sensitive!).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>The `PreserveAllConnections` parameter should be used with caution. It seriously degrades performance because of how the export is performed. Unless you have items with more than 2000 connected items, you do not need to use this parameter.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------------- Example 1 (Category) ---------------------</maml:title> <dev:code>Export-CmcData -CategoryName Account -OutputPath account.xml</dev:code> <dev:remarks> <maml:para>Exports all fields in category 'Account' to file 'account.xml'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code># Uses Tutorial dabase # define fields we want to get $fields = "accountKey", "Address", "cityStateZip", "businessNumber" # define array of related columns $rc = @((Get-CmcConnectedField 'Relates to' Contact contactKey), (Get-CmcConnectedField 'Relates to' Contact emailBusiness)) # define a Field (type F) filter for items where the field called accountKey does not contain string 'Leap', case-sensitive $filter = Get-CmcFilter 1 Field accountKey Contains Leap -Except -MatchCase Export-CmcData -c Account -FieldNames $fields -Filters $filter -ConnectedFields $rc -ExportFormat Json -Outputpath account.json</dev:code> <dev:remarks> <maml:para>Export specified fields to a Json file</maml:para> <maml:para>Advanced example (using Tutorial database ): export</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----------------------- Example 3 (View) -----------------------</maml:title> <dev:code>Export-CmcData -v 'Contact List' -OutputPath contactlist.xml</dev:code> <dev:remarks> <maml:para>Export view 'Contact List` to file 'contactlist.xml' using default settings.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CmcFilter</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CmcConnectedField</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-CmcView</command:name> <command:verb>Find</command:verb> <command:noun>CmcView</command:noun> <maml:description> <maml:para>Find a Commence view.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Can be used to search for Commence views by name, category or viewtype.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-CmcView</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ViewName</maml:name> <maml:description> <maml:para>(First characters of) the view name to find.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="c"> <maml:name>CategoryName</maml:name> <maml:description> <maml:para>Commence category to filter views on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="t"> <maml:name>ViewType</maml:name> <maml:description> <maml:para>The Commence viewtype to filter views on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="c"> <maml:name>CategoryName</maml:name> <maml:description> <maml:para>Commence category to filter views on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ViewName</maml:name> <maml:description> <maml:para>(First characters of) the view name to find.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="t"> <maml:name>ViewType</maml:name> <maml:description> <maml:para>The Commence viewtype to filter views on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Vovin.CmcLibNet.Database.Metadata.IViewDef</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Will not return views of type MultiView or Document because they are not exposed by Commence.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Find-CmcView</dev:code> <dev:remarks> <maml:para>Without parameters it will output all views in Commence.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Find-CmcView -ViewName prod</dev:code> <dev:remarks> <maml:para>Will search the list of views for views that have a name that starts with 'prod'. The `-ViewName` parameter supports tab-completion after the first run. Note that while view names in Commence are case-sensitive, this argument is not.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code># using Tutorial database Find-CmcView prod -CategoryName Product -ViewType Report</dev:code> <dev:remarks> <maml:para>Will list the views that start with 'prod' in category 'Product' and are of type 'Report'. The `-CategoryName` and `-ViewType` parameters both support tab-completion.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CmcActiveViewInfo</command:name> <command:verb>Get</command:verb> <command:noun>CmcActiveViewInfo</command:noun> <maml:description> <maml:para>Get information on currently showing view in Commence.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get information on currently showing view in Commence.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcActiveViewInfo</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-CmcActiveViewInfo</dev:code> <dev:remarks> <maml:para>Gets information on currently showing view in Commence. If no view is showing the return object's properties are blank. Property values may also be blank depending on the type of view that is active.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CmcCategories</command:name> <command:verb>Get</command:verb> <command:noun>CmcCategories</command:noun> <maml:description> <maml:para>Get categories from Commence</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the category definitions from the currently active Commence database.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcCategories</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-CmcCategories</dev:code> <dev:remarks> <maml:para>Returns the category definitions of the currently active Commence database.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>(Get-CmcCategories).Name</dev:code> <dev:remarks> <maml:para>Show all category names.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-CmcCategories | Where-Object { $_.Clarified -eq $true } | select Name, ClarifyField, ClarifySeparator</dev:code> <dev:remarks> <maml:para>Show all clarified categories and their clarify field and separator.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CmcConnectedField</command:name> <command:verb>Get</command:verb> <command:noun>CmcConnectedField</command:noun> <maml:description> <maml:para>Get a related column (field).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Defines a connected field to retrieve from a Commence category or view.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcConnectedField</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="cn"> <maml:name>ConnectionName</maml:name> <maml:description> <maml:para>Commence connection name (case-sensitive).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="c"> <maml:name>ToCategoryName</maml:name> <maml:description> <maml:para>Connected Commence category name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="f"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>Commence fieldname in the connected category.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="cn"> <maml:name>ConnectionName</maml:name> <maml:description> <maml:para>Commence connection name (case-sensitive).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="f"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>Commence fieldname in the connected category.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="c"> <maml:name>ToCategoryName</maml:name> <maml:description> <maml:para>Connected Commence category name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PoshCommence.ConnectedField</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-CmcConnectedField 'Relates to' Contact contactKey</dev:code> <dev:remarks> <maml:para>Get a related column pointing to the 'contactKey' field in connection 'Relates to' to category 'Contact'.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/arnovb-github/CmcLibNet</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CmcConnectedItemCount</command:name> <command:verb>Get</command:verb> <command:noun>CmcConnectedItemCount</command:noun> <maml:description> <maml:para>Get the number of connected items in Commence.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the number of connected items for the specified connection in Commence.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcConnectedItemCount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>FromCategory</maml:name> <maml:description> <maml:para>Name of the primary Commence category.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ConnectionName</maml:name> <maml:description> <maml:para>Name of the Commence connection (case-sensitive!).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ToCategory</maml:name> <maml:description> <maml:para>Name of connected Commence category to count connections of.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>FromItem</maml:name> <maml:description> <maml:para>Name of the item to return connected item count on. Do not provide a clarified itemname.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>ClarifySeparator</maml:name> <maml:description> <maml:para>Commence clarify sepator for category.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ClarifyValue</maml:name> <maml:description> <maml:para>Clarify value. (i.e., not the fully clarified itemname.)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>ClarifySeparator</maml:name> <maml:description> <maml:para>Commence clarify sepator for category.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ClarifyValue</maml:name> <maml:description> <maml:para>Clarify value. (i.e., not the fully clarified itemname.)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ConnectionName</maml:name> <maml:description> <maml:para>Name of the Commence connection (case-sensitive!).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>FromCategory</maml:name> <maml:description> <maml:para>Name of the primary Commence category.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>FromItem</maml:name> <maml:description> <maml:para>Name of the item to return connected item count on. Do not provide a clarified itemname.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ToCategory</maml:name> <maml:description> <maml:para>Name of connected Commence category to count connections of.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>A return value of -1 means that the item was not found.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-CmcConnectedItemCount Account 'Relates to' Contact | Where-Object { $_.Count -gt 1 } | Select-Object -Property Itemname, Count</dev:code> <dev:remarks> <maml:para>Get the itemnames and count from Contact items connected to Account via the 'Relates to' connection where more than 1 such connected item exists ( Tutorial database ).</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CmcConnections</command:name> <command:verb>Get</command:verb> <command:noun>CmcConnections</command:noun> <maml:description> <maml:para>Get the connections from Commence.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the connectionnames and their categoryname to the specfied category in Commence.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcConnections</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="c"> <maml:name>CategoryName</maml:name> <maml:description> <maml:para>Commence category name to get connections for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="c"> <maml:name>CategoryName</maml:name> <maml:description> <maml:para>Commence category name to get connections for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-CmcConnections Account</dev:code> <dev:remarks> <maml:para>Returns the connections and their categoryname for the 'Account' category.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CmcData</command:name> <command:verb>Get</command:verb> <command:noun>CmcData</command:noun> <maml:description> <maml:para>Gets fieldvalues from Commence.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the specfied fieldvalues from a Commence category. Can use a category or view as datasource.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcData</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="c"> <maml:name>CategoryName</maml:name> <maml:description> <maml:para>Commence category to get data from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>FieldNames</maml:name> <maml:description> <maml:para>Commence fieldnames.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ConnectedFields</maml:name> <maml:description> <maml:para>Fields from connections.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConnectedField[]</command:parameterValue> <dev:type> <maml:name>ConnectedField[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Filters to apply.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ICursorFilter[]</command:parameterValue> <dev:type> <maml:name>ICursorFilter[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UseThids</maml:name> <maml:description> <maml:para>Include the Commence THID. Ignored when `-UseView` is set.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-CmcData</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="v"> <maml:name>ViewName</maml:name> <maml:description> <maml:para>Commence view name to get data from (case-sensitive!).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>FieldNames</maml:name> <maml:description> <maml:para>Commence fieldnames.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ColumnLabels</maml:name> <maml:description> <maml:para>Use columnlabels in the view instead of the fieldnames</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ConnectedFields</maml:name> <maml:description> <maml:para>Fields from connections.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConnectedField[]</command:parameterValue> <dev:type> <maml:name>ConnectedField[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Filters to apply.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ICursorFilter[]</command:parameterValue> <dev:type> <maml:name>ICursorFilter[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="c"> <maml:name>CategoryName</maml:name> <maml:description> <maml:para>Commence category to get data from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ColumnLabels</maml:name> <maml:description> <maml:para>Use columnlabels in the view instead of the fieldnames</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ConnectedFields</maml:name> <maml:description> <maml:para>Fields from connections.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ConnectedField[]</command:parameterValue> <dev:type> <maml:name>ConnectedField[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>FieldNames</maml:name> <maml:description> <maml:para>Commence fieldnames.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Filters to apply.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ICursorFilter[]</command:parameterValue> <dev:type> <maml:name>ICursorFilter[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UseThids</maml:name> <maml:description> <maml:para>Include the Commence THID. Ignored when `-UseView` is set.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="v"> <maml:name>ViewName</maml:name> <maml:description> <maml:para>Commence view name to get data from (case-sensitive!).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Connected data are returned just as Commence returns them. That means that they are either comma-delimited or newline-delimited strings, depending on the type of the underlying data source. Different viewtypes return different formats. This can make working with related data quite hard. When you want to work with connected items it is probably easier to export the data to a file first. The export engine will treat connected items as seperarate entities (if possible). You need to export to XML or Json format for this.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-CmcData Account accountKey, businessNumber</dev:code> <dev:remarks> <maml:para>Gets the fieldvalues for the 'accountKey' and 'businessNumber' from the 'Account' category.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code># Using Tutorial dabase # define fields we want to get $fields = "accountKey", "Address", "cityStateZip", "businessNumber" # define related columns we want to get $rc1 = Get-CmcConnectedField 'Relates to' Contact contactKey $rc2 = Get-CmcConnectedField 'Relates to' Contact emailBusiness # define a Field (type F) filter for items where the field called accountKey does not contain string 'Leap', case-sensitive $filter = Get-CmcFilter 1 Field "accountKey" Contains Leap -Except -MatchCase Get-CmcData -c Account -FieldNames $fields -Filters $filter -ConnectedFields $rc1, $rc2</dev:code> <dev:remarks> <maml:para>Advanced example using filters and related columns.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>powershell # Uses Tutorial dabase Get-CmcData -v 'Account Default' (Get-CmcFields Account).Name | Out-GridView</dev:code> <dev:remarks> <maml:para>Getting funky: show your own "Commence view" using the data in the "Account Default" view but with all available fields in the "Account" category. This may appear a little silly, but a `GridView` allows for quick filtering on any field.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CmcFilter</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CmcConnectedField</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CmcDatabaseDirectory</command:name> <command:verb>Get</command:verb> <command:noun>CmcDatabaseDirectory</command:noun> <maml:description> <maml:para>Get Commence database directory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the database directory of the currently active Commence database.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcDatabaseDirectory</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> "The full database path is " + (Get-CmcDatabaseDirectory).FullName</dev:code> <dev:remarks> <maml:para>Get the database directory of the currently active Commence database.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CmcDatabaseName</command:name> <command:verb>Get</command:verb> <command:noun>CmcDatabaseName</command:noun> <maml:description> <maml:para>Get Commence database name.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the name of the running Commence database.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcDatabaseName</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-CmcDatabaseName</dev:code> <dev:remarks> <maml:para>Gets the name of the running Commence database.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CmcDbSize</command:name> <command:verb>Get</command:verb> <command:noun>CmcDbSize</command:noun> <maml:description> <maml:para>Gets the size of the Commence database.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the size in bytes of all files combined in the running Commence database directory.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcDbSize</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Long</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Will include all files in the Commence database directory even if they are not part of the database.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>(Get-CmcDbSize) / 1024</dev:code> <dev:remarks> <maml:para>Gets the combined size in megabytes of all files in the running Commence database.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CmcFields</command:name> <command:verb>Get</command:verb> <command:noun>CmcFields</command:noun> <maml:description> <maml:para>Get field defitions form Commence category.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the fieldnames from the specfied Commence category.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcFields</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="c"> <maml:name>CategoryName</maml:name> <maml:description> <maml:para>Commence category name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="c"> <maml:name>CategoryName</maml:name> <maml:description> <maml:para>Commence category name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-CmcFields Account</dev:code> <dev:remarks> <maml:para>Gets all field definitions for the fields in category 'Account'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>(Get-CmcFields Account).Name</dev:code> <dev:remarks> <maml:para>List the fieldnames in category 'Account'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-CmcFields Account | Where-Object { $_.Type -eq "Telephone" }</dev:code> <dev:remarks> <maml:para>Get the fields of type 'Telephone' for category 'Account'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-CmcFields Account | Where-Object { $_.Type -eq [Vovin.CmcLibNet.Database.CommenceFieldType]::Telephone }</dev:code> <dev:remarks> <maml:para>Same as previous example, but this time using the predefined enumeration in `[Vovin.CmcLibNet.Datbase.FieldType]`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Get-CmcFields Account | Where-Object { $_.Type -eq 3 }</dev:code> <dev:remarks> <maml:para>Same as previous example, but this time using the numerical value from the predefined enumeration in [Vovin.CmcLibNet.Datbase.FieldType].</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CmcFilter</command:name> <command:verb>Get</command:verb> <command:noun>CmcFilter</command:noun> <maml:description> <maml:para>Create a filter object used to filter Commence data.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Note This is a dynamic command. For every `-FilterType` value, there is a separate set of parameters. See the examples for a full overview (Get-Help Get-CmcFilter -Example). This command creates a filter object of a specific type for filtering Commence data.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcFilter</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ClauseNumber</maml:name> <maml:description> <maml:para>Clause number.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">1</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">2</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">4</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">5</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">6</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">7</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">8</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="t, Type"> <maml:name>FilterType</maml:name> <maml:description> <maml:para>Filter type. For each type there is a different set of parameters.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Field</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectionToItem</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectionToCategoryToItem</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectionToCategoryField</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">FilterType</command:parameterValue> <dev:type> <maml:name>FilterType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>Commence fieldname. Only used in F and CTCF filters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Qualifier</maml:name> <maml:description> <maml:para>Commence filter qualifier. Only used in F and CTCF filters. See the examples.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Contains</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DoesNotContain</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">On</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">At</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EqualTo</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotEqualTo</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LessThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GreaterThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Between</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">True</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">False</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Checked</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotChecked</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">No</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Before</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">After</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Blank</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Shared</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Local</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">One</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Zero</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">FilterQualifier</command:parameterValue> <dev:type> <maml:name>FilterQualifier</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>FieldValue</maml:name> <maml:description> <maml:para>Commence field value. Only used in F and CTCF filters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>FieldValue2</maml:name> <maml:description> <maml:para>Commence field value used with the Between qualifier. Only used in F and CTCF filters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Except</maml:name> <maml:description> <maml:para>Invert filter. Same as checking the 'Except' checkbox in the Commence filter UI.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MatchCase</maml:name> <maml:description> <maml:para>Match case-sensitive. Only used in F and CTCF filters.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrFilter</maml:name> <maml:description> <maml:para>Set filter conjunction to OR (if omitted, defaults to AND).</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ClauseNumber</maml:name> <maml:description> <maml:para>Clause number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Except</maml:name> <maml:description> <maml:para>Invert filter. Same as checking the 'Except' checkbox in the Commence filter UI.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>Commence fieldname. Only used in F and CTCF filters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>FieldValue</maml:name> <maml:description> <maml:para>Commence field value. Only used in F and CTCF filters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>FieldValue2</maml:name> <maml:description> <maml:para>Commence field value used with the Between qualifier. Only used in F and CTCF filters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="t, Type"> <maml:name>FilterType</maml:name> <maml:description> <maml:para>Filter type. For each type there is a different set of parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FilterType</command:parameterValue> <dev:type> <maml:name>FilterType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MatchCase</maml:name> <maml:description> <maml:para>Match case-sensitive. Only used in F and CTCF filters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrFilter</maml:name> <maml:description> <maml:para>Set filter conjunction to OR (if omitted, defaults to AND).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Qualifier</maml:name> <maml:description> <maml:para>Commence filter qualifier. Only used in F and CTCF filters. See the examples.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FilterQualifier</command:parameterValue> <dev:type> <maml:name>FilterQualifier</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Vovin.CmcLibNet.Database.ICursorFilterF (Field)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Vovin.CmcLibNet.Database.ICursorFilterCTI (ConnectionToItem)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Vovin.CmcLibNet.Database.ICursorFilterCTCF (ConnectionToCategoryField)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Vovin.CmcLibNet.Database.ICursorFilterCTCTI (ConnectionToCategoryToItem)</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Most paramaters support automatic argument-completion.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------- Example: Get syntax help -------------------</maml:title> <dev:code>Get-Command Get-CmcFilter -syntax -Args '-FilterType', ConnectionToItem</dev:code> <dev:remarks> <maml:para>Displays the syntax used with the 'ConnectionToItem' filtertype.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----------- Example: Get syntax for filtertype Field -----------</maml:title> <dev:code>Get-CmcFilter [-ClauseNumber] <Int32> [-FilterType] <FilterType> [-Except] [-OrFilter] -FieldName <String> -Qualifier <FilterQualifier> -FieldValue <String> [-FieldValue2 <String>] [-MatchCase] [<CommonParameters>]</dev:code> <dev:remarks> <maml:para>Syntax for FilterType Field (F). This is the default FilterType.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------- Example: Usage of filtertype Field --------------</maml:title> <dev:code>Get-CmcFilter -ClauseNumber 1 -FilterType Field -FieldName "accountKey" -Qualifier Between -FieldValue "A*" -FieldValue2 "K*" -MatchCase</dev:code> <dev:remarks> <maml:para>( Tutorial database ) Sets filter with clause 1 on field 'accountKey' to filter for a value that starts with a 'A' up to and including values that start with 'K', case-sensitive.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------ Example: Usage of filtertype Field (short syntax) ------</maml:title> <dev:code>Get-CmcFilter 1 0 accountKey Between "A*" "K*" -MatchCase</dev:code> <dev:remarks> <maml:para>( Tutorial database ) The same filter in its shortest form. Note that the 0 repesents the numeric value of the 'Field' `FilterType`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----- Example: Get syntax for filtertype ConnectionToItem -----</maml:title> <dev:code>Get-CmcFilter [-ClauseNumber] <Int32> [-FilterType] <FilterType> [-Connection] <String> [-ToCategoryName] <String> [-Item] <String> [-Except] [-OrFilter] [<CommonParameters>]</dev:code> <dev:remarks> <maml:para>Syntax for FilterType ConnectionToItem (CTI).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------- Example: Usage of filtertype ConnectionToItem --------</maml:title> <dev:code>Get-CmcFilter -ClauseNumber 3 -FilterType ConnectionToItem -Connection 'Relates to' -ToCategoryName 'Contact' -Item 'Rubbel.John'</dev:code> <dev:remarks> <maml:para>( Tutorial database ) Sets a filter with clause 2 that returns items in 'Account' that are connected to to item 'Rubbel.John' over connection 'Relates to' to category 'Contact'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>- Example: Usage of filtertype ConnectionToItem (short syntax) -</maml:title> <dev:code>Get-CmcFilter 3 1 'Relates to' 'Contact' 'Rubbel.John'</dev:code> <dev:remarks> <maml:para>( Tutorial database ) The same filter in its shortest form. Note that the 1 repesents the numeric value of the 'ConnectionToItem' `FilterType`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title> Example: Get syntax for filtertype ConnectionToCategoryToItem </maml:title> <dev:code>Get-CmcFilter [-ClauseNumber] <Int32> [-FilterType] <FilterType> [-Connection] <String> [-ToCategoryName] <String> [-Connection2] <String> [-ToCategoryName2] <String> [-Item] <String> [-Except] [-OrFilter] [<CommonParameters>]</dev:code> <dev:remarks> <maml:para>Syntax for Filtertype ConnectionToCategoryToItem (CTCTI).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--- Example: Usage of filtertype ConnectionToCategoryToItem ---</maml:title> <dev:code>Get-CmcFilter -ClauseNumber 5 -FilterType ConnectionToCategoryToItem -Connection 'Relates To' -ToCategoryName 'Contact' -Connection2 'Handheld Device' -ToCategoryName2 'Employee' -Item 'Devol.Eric.L'</dev:code> <dev:remarks> <maml:para>( Tutorial database ) Sets a filter with clause 3 that returns items in 'Account' that are connected to to items in 'Contact over connection 'Relates to' that are connected to an item ''Devol.Eric.L' in category 'Employee' over connection 'Hanheld Device'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example: Usage of filtertype ConnectionToCategoryToItem (short syntax)</maml:title> <dev:code>Get-CmcFilter 5 2 'Relates To' 'Contact' 'Handheld Device' 'Employee' 'Devol.Eric.L'</dev:code> <dev:remarks> <maml:para>( Tutorial database ) The same filter in its shortest form. Note that the 2 repesents the numeric value of the 'ConnectionToCategoryToItem' `FilterType`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>- Example: Get syntax for filtertype ConnectionToCategoryField -</maml:title> <dev:code>Get-CmcFilter [-ClauseNumber] <int> [-FilterType] <FilterType> [-Connection] <string> [-ToCategoryName] <string> [-FieldName] <string> [-Qualifier] <FilterQualifier> [-FieldValue] <string> [[-FieldValue2] <string>] [-Except] [-OrFilter] [-MatchCase] [<CommonParameters>]</dev:code> <dev:remarks> <maml:para>Syntax for Filtertype ConnectionToCategoryField (CTCF).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---- Example: Usage of filtertype ConnectionToCategoryField ----</maml:title> <dev:code>Get-CmcFilter -ClauseNumber 7 -FilterType ConnectionToCategoryField -Connection 'Relates to' -ToCategoryName 'Employee' -FieldName 'Title' -Qualifier EqualTo -FieldValue 'Telemarketer'</dev:code> <dev:remarks> <maml:para>( Tutorial database ) Filter category 'Account' for connected items in category 'Employee' that have a 'Title' field value equal to 'Telemarketer'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---- Example: Usage of filtertype ConnectionToCategoryField ----</maml:title> <dev:code>Get-CmcFilter 7 3 'Relates to' Employee Title EqualTo 'Telemarketer'</dev:code> <dev:remarks> <maml:para>( Tutorial database ) The same filter in its shortest form. Note that the 3 repesents the numeric value of the 'ConnectionToCategoryField' `FilterType`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------ Example: Get available FilterType names and values ------</maml:title> <dev:code>[Enum]::GetValues([Vovin.CmcLibNet.Database.FilterType]) | % { Write-Host $_ $_.Value__}</dev:code> <dev:remarks> <maml:para>When you specify a `-FilterType` value, use tab-completion to cycle through all named values. This example outputs all the names and the corresponding numerical values numbers of the [FilterType] enum.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------ Example: Get available Qualifier names and values ------</maml:title> <dev:code>[Enum]::GetValues([Vovin.CmcLibNet.Database.FilterQualifier]) | % { Write-Host $_ $_.Value__}</dev:code> <dev:remarks> <maml:para>When you specify a `-Qualifier` value, use tab-completion to cycle through all named values. This example outputs all the names and the corresponding numerical values numbers of the [FilterQualifier] enum.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----------- Example: Get the resulting filterstring -----------</maml:title> <dev:code>(Get-CmcFilter 1 0 accountKey Between "A*" "K*" -MatchCase).ToString() # or use a more convenient way $f = Get-CmcFilter 1 0 accountKey Between "A*" "K*" -MatchCase $f # ToString() is called implicitly</dev:code> <dev:remarks> <maml:para>Output: '[ViewFilter(1,F,,"accountKey","Between","A ","K ")]'</maml:para> <maml:para>The filter objects created under the hood all have a `ToString()` method that generates the DDE filter syntax that `ICommenceCursor.SetFilter()` expects.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CmcIniFile</command:name> <command:verb>Get</command:verb> <command:noun>CmcIniFile</command:noun> <maml:description> <maml:para>Get Commence settings file</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a `PSobject` object pointing to Commence's data.ini settings file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcIniFile</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-CmcIniFile | Get-Content</dev:code> <dev:remarks> <maml:para>Gets the contents of the file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CmcItemCount</command:name> <command:verb>Get</command:verb> <command:noun>CmcItemCount</command:noun> <maml:description> <maml:para>Get item count for category.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the number of items in a Commence category.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcItemCount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="c"> <maml:name>CategoryName</maml:name> <maml:description> <maml:para>Commence category name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="c"> <maml:name>CategoryName</maml:name> <maml:description> <maml:para>Commence category name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-CmcItemCount Account</dev:code> <dev:remarks> <maml:para>Returns the number of items in category 'Account'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-CmcCategories | Get-CmcItemCount</dev:code> <dev:remarks> <maml:para>Returns all categorynames and their item count.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-CmcCategories | Get-CmcItemCount | Measure-Object -Property ItemCount -Sum</dev:code> <dev:remarks> <maml:para>Count all items in the database.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CmcLogFile</command:name> <command:verb>Get</command:verb> <command:noun>CmcLogFile</command:noun> <maml:description> <maml:para>Get Commence active.log file</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a `PSObject` object pointing to Commence's active.log file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcLogFile</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-CmcLogFile | Get-Content -Tail 10</dev:code> <dev:remarks> <maml:para>Returns the last 10 lines of the Commence log file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CmcPreference</command:name> <command:verb>Get</command:verb> <command:noun>CmcPreference</command:noun> <maml:description> <maml:para>Get Commence preference setting.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the preference settings as exposed by Commence.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcPreference</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Preference</maml:name> <maml:description> <maml:para>Preference item to retrieve.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Me</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MeCategory</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LetterLogDir</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ExternalDir</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Preference</maml:name> <maml:description> <maml:para>Preference item to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-CmcPreference Me</dev:code> <dev:remarks> <maml:para>Gets the (-Me-) item, if defined.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Open-CmcView</command:name> <command:verb>Open</command:verb> <command:noun>CmcView</command:noun> <maml:description> <maml:para>Open a view in Commence.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Typically used in conjunction with Find-CmcView (Find-CmcView.md). Opens the view(s)in Commence and puts the window focus on Commence.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Open-CmcView</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="v, ViewName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Commence view name. Case-sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>NewCopy</maml:name> <maml:description> <maml:para>Opens a copy of the view even if it was already opened.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Max</maml:name> <maml:description> <maml:para>Maximum number of views to open. Keep this member small or Commence or your brain will explode.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Max</maml:name> <maml:description> <maml:para>Maximum number of views to open. Keep this member small or Commence or your brain will explode.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="v, ViewName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Commence view name. Case-sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>NewCopy</maml:name> <maml:description> <maml:para>Opens a copy of the view even if it was already opened.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Vovin.CmcLibNet.Database.Metadata.IViewDef</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Find-CmcView -Name Product | Open-CmcView</dev:code> <dev:remarks> <maml:para>Will open all views that contain 'Product' in their name. NOTE If the number of views passed to this cmdlet exceeds a threshold, only the first number of views up to that threshold will be opened. At the time of writing this threshold is 5.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Open-CmcView 'All Accounts'</dev:code> <dev:remarks> <maml:para>Will open the view called 'All Accounts'. View names are case-sensitive.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Find-CmcView</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-CmcFilter</command:name> <command:verb>Test</command:verb> <command:noun>CmcFilter</command:noun> <maml:description> <maml:para>Test if filter is valid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Test if filter is syntactically valid by applying it to see if errors are thrown.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-CmcFilter</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="c"> <maml:name>Category</maml:name> <maml:description> <maml:para>Commence category to apply filter on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter object</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ICursorFilter</command:parameterValue> <dev:type> <maml:name>ICursorFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="c"> <maml:name>Category</maml:name> <maml:description> <maml:para>Commence category to apply filter on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter object</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ICursorFilter</command:parameterValue> <dev:type> <maml:name>ICursorFilter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Use of this cmdlet in production environments is discouraged because it is a resource intensive operation.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$f = Get-CmcFilterF 1 accountKey EqualTo 'A' Test-CmcFilter Account $f -Verbose</dev:code> <dev:remarks> <maml:para>Test validity of filter `$f`. Assuming the Tutorial database this filter should pass.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |