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-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></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="none"> <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>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>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>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>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="none"> <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>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>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>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>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>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="none"> <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>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>None</maml:name> </dev:type> <maml:description> <maml:para>Writes data to a file.</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 (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>Finds</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>Name</maml:name> <maml:description> <maml:para>(Part 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>Type</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>Name</maml:name> <maml:description> <maml:para>(Part 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>Type</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 Commence MultiViews 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 the complete list of views in Commence.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Find-CmcView prod</dev:code> <dev:remarks> <maml:para>The first parameter will search the list of views for views that have names that contain the argument 'prod'. The `-Name` parameter supports tab-completion after the first run.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code># using Tutorial database Find-CmcView prod -Category Product -Type Report</dev:code> <dev:remarks> <maml:para>Will list the views that match 'prod' in category 'Product' and of type 'Report Viewer'. The `-Category` and `-Type` parameters both have 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-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="none"> <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="none"> <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="none"> <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="none"> <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="False" 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="False" 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 to 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="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: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>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></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>System.IO.DirectoryInfo</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="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>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:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" 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="named" 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="named" 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>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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" 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: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="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>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="named" 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="named" 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="named" 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>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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" 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>----------------------- 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>-------------------- Syntax for type 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>--------------------- Usage of type 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>--------------- Usage of type Field (short form) ---------------</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>--------------- Syntax for type 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>---------------- Usage of type 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>--------- Usage of type ConnectionToItem (short form) ---------</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>---------- Syntax for type 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>----------- Usage of type 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>---- Usage of type ConnectionToCategoryToItem (short form) ----</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>------------- Syntax for 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>----------- Usage of type 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>----------- Usage of type 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>--------------- Get 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, you can use tab-completion to cycle through all named values. This example outputs the names and the corresponding numerical values numbers of the [FilterType] enum.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------------- Get 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, you can use tab-completion to cycle through all named values. This example outputs the names and the corresponding numerical values numbers of the [FilterQualifier] enum.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--------------------- Get the filterstring ---------------------</maml:title> <dev:code>(Get-CmcFilter 1 0 accountKey Between "A*" "K*" -MatchCase).ToString() # a more convenient way $f = Get-CmcFilter 1 0 accountKey Between "A*" "K*" -MatchCase $f # ToString() is implicit</dev:code> <dev:remarks> <maml:para>Output: '[ViewFilter(1,F,,"accountKey","Between","A ","K ")]'</maml:para> <maml:para>Seasoned Commence API users at this point may go 'WTF is happening here? Create objects for filtering Commence data? How does that work?'</maml:para> <maml:para>What happens under the hood is, when a filter is applied, the filter object is turned into a specially formatted string that is passed to the `ICommenceCursor.SetFilter(...)` method.</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 `FileInfo` 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>System.IO.FileInfo</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-Content (Get-CmcIniFile).FullName</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. A value of -1 means that the category was not found.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcItemCount</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.Int32</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: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 `FileInfo` 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>System.IO.FileInfo</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-Content (Get-CmcLogFile).FullName -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>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 (ByValue)" position="0" aliases="none"> <maml:name>View</maml:name> <maml:description> <maml:para>View objects returned by `Find-CmcView`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IViewDef[]</command:parameterValue> <dev:type> <maml:name>IViewDef[]</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 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:syntaxItem> </command:syntax> <command:parameters> <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 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:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>View</maml:name> <maml:description> <maml:para>View objects returned by `Find-CmcView`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IViewDef[]</command:parameterValue> <dev:type> <maml:name>IViewDef[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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>There is a maximum to the total number of views that Commence can show. In order to not make Commence blow up in your face immediately, there is a hard-coded limit to the amount of views this cmdlet will open. It may still blow up, just not immediately.</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: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> |