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>Export-CmcCategory</command:name> <command:verb>Export</command:verb> <command:noun>CmcCategory</command:noun> <maml:description> <maml:para>Export a category to file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use this to export the data in a Commence category to a file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-CmcCategory</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>CategoryName</maml:name> <maml:description> <maml:para>Name of Commence category to export 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>ExportFormat</maml:name> <maml:description> <maml:para>File type 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. Does no accept related fields.</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>Array of `CursorFilter`s 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>SkipConnectedItems</maml:name> <maml:description> <maml:para>Do not export connected items.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UseThids</maml:name> <maml:description> <maml:para>Include THID in export.</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>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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>CategoryName</maml:name> <maml:description> <maml:para>Name of Commence category to export 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>ExportFormat</maml:name> <maml:description> <maml:para>File type 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. Does no accept related fields.</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>Array of `CursorFilter`s 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>SkipConnectedItems</maml:name> <maml:description> <maml:para>Do not export connected items.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UseThids</maml:name> <maml:description> <maml:para>Include THID in export.</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>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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None.</maml:name> </dev:type> <maml:description> <maml:para>You cannot pipe input to this cmdlet.</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 to a file.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Use this cmdlet for simple exports. For advanced exporting, see Vovin.CmcLibNet (https://github.com/arnovb-github/CmcLibNet).</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Export-CmcCategory Account accounts.xml</dev:code> <dev:remarks> <maml:para>Simple example (using Tutorial database ): Export the entire Account category to file account.xml using default settings.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code># create array of filters $filters = @((Get-CmcFilterF 1 accountKey 0 Wing), (Get-CmcFilterCTI 2 'Relates to' 'salesTeam' 'Team 1' -OrFilter)) # perform the export Export-CmcCategory Account accounts.json -ExportFormat Json -Filters $filters -FieldNames accountKey, Address, City, zipPostal, Country, 'Relates to Employee'</dev:code> <dev:remarks> <maml:para>Advanced example (using Tutorial database ): export address fields and list of Sales person of items in Account that have 'Wing' in their name or are connected to 'salesTeam' item 'Team 1' to a Json file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CmcFilterF</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CmcFilterCTI</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CmcFilterCTCF</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CmcFilterCTCTI</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Vovin.CmcLibNet</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>Export-CmcView</command:name> <command:verb>Export</command:verb> <command:noun>CmcView</command:noun> <maml:description> <maml:para>Export a Commence view to file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Export a Commence view to file if the view supports it.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-CmcView</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <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="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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>{{ Fill OutputPath Description }}</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="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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <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="named" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>{{ Fill OutputPath Description }}</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>You cannot pipe input to this cmdlet.</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 to a file.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Not all Commence viewtypes support exporting.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Export-CmcView '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 /> </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 category names from Commence</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the category names of 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.String[]</maml:name> </dev:type> <maml:description> <maml:para>Returns an array of strings.</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-CmcCategories</dev:code> <dev:remarks> <maml:para>Returns the category names 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-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:syntaxItem> </command:syntax> <command:parameters> <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="none"> <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="none"> <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>PS C:\> 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-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>When Commence is not running, or more than one instance of Commence is running, this cmdlet will throw an error.</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>When Commence is not running, or more than one instance of Commence is running, this cmdlet will throw an error.</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-CmcExportFormats</command:name> <command:verb>Get</command:verb> <command:noun>CmcExportFormats</command:noun> <maml:description> <maml:para>Get available export formats.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the export formats available for the Export cmdlets.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcExportFormats</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>Vovin.CmcLibNet.Export.ExportFormat</maml:name> </dev:type> <maml:description> <maml:para>Enum values of the available export formats.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Not all export formats may be implemented or suitable for use in Powershell.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-CmcExportFormats</dev:code> <dev:remarks> <maml:para>Get the export formats available for the Export cmdlets.</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 fieldnames 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="none"> <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="none"> <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.String[]</maml:name> </dev:type> <maml:description> <maml:para>Returns an array of strings.</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 | Where-Object { $_.Type -eq Name }</dev:code> <dev:remarks> <maml:para>Get the Name field for category Account. The Name argument has special meaning. See the next example.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-CmcFields Account | Where-Object { $_.Type -eq [Vovin.CmcLibNet.Database.CommenceFieldType]::Name }</dev:code> <dev:remarks> <maml:para>Get the Name field for category Account using the predefined enumeration in [Vovin.CmcLibNet.Datbase.FieldType].</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-CmcFields Account | Where-Object { $_.Type -eq 11 }</dev:code> <dev:remarks> <maml:para>Get the Name field for category Account 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-CmcFieldTypes</command:name> <command:verb>Get</command:verb> <command:noun>CmcFieldTypes</command:noun> <maml:description> <maml:para>Get Commence field types.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the Commence fieldtypes as specified in `Vovin.CmcLibNet.Database.CommenceFieldType`. Numerical values are equal to the native Commence RM API values.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcFieldTypes</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>Vovin.CmcLibNet.Datase.CommenceFieldType</maml:name> </dev:type> <maml:description> <maml:para>Enum values of the field types.</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-CmcFieldTypes</dev:code> <dev:remarks> <maml:para>Gets the Commence fieldtypes as specified in `Vovin.CmcLibNet.Database.CommenceFieldType`.</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-CmcFieldValues</command:name> <command:verb>Get</command:verb> <command:noun>CmcFieldValues</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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcFieldValues</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>CategoryOrViewName</maml:name> <maml:description> <maml:para>Commence category or view name. View names are 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>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>RelatedColumns</maml:name> <maml:description> <maml:para>Related columns to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RelatedColumn[]</command:parameterValue> <dev:type> <maml:name>RelatedColumn[]</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. Only works on categories, not views.</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>UseView</maml:name> <maml:description> <maml:para>Indicate that `-CategoryOrViewName` refers to a view name, not a category name.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>CategoryOrViewName</maml:name> <maml:description> <maml:para>Commence category or view name. View names are 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>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>RelatedColumns</maml:name> <maml:description> <maml:para>Related columns to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RelatedColumn[]</command:parameterValue> <dev:type> <maml:name>RelatedColumn[]</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. Only works on categories, not views.</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>UseView</maml:name> <maml:description> <maml:para>Indicate that `-CategoryOrViewName` refers to a view name, not a category name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>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.CommenceField</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-CmcFieldValues CategoryName FieldName1, FieldName2</dev:code> <dev:remarks> <maml:para>Gets all fieldvalues for fields FieldName1 and Fieldame2.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code># Example for Tutorial dabase # define some fields we want to get $fields = "accountKey", "Address", "cityStateZip", "businessNumber" # define related columns we want to get $rc1 = Get-CmcRelatedColumn 'Relates to' Contact contactKey $rc2 = Get-CmcRelatedColumn 'Relates to' Contact emailBusiness # define a Field (type F) filter for items where the field called Name does not contain string 'test', case-sensitive # the `0` represents the numerical value of enum value [Vovin.CmcLibNet.Database.FilterQualifier]::Contains $filter = Get-CmcFilterF 1 "accountKey" 0 test -Except -MatchCase Get-CmcFieldValues Account -FieldNames $fields -Filters $filter -RelatedColumns $rc1, $rc2</dev:code> <dev:remarks> <maml:para>Advanced example using filters and related columns.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CmcFilterF</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CmcFilterCTI</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CmcFilterCTCF</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CmcFilterCTCTI</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CmcRelatedColumn</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-CmcFilterCTCF</command:name> <command:verb>Get</command:verb> <command:noun>CmcFilterCTCF</command:noun> <maml:description> <maml:para>Get a Commence CTCF filter.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a Commence Connection To Connected Field (CTCF) filter. Filters for items in A that have a connected items in B where field X matched the filter value.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcFilterCTCF</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>Position of the filter (1-8).</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="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Connection</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>Category</maml:name> <maml:description> <maml:para>Connected 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="3" aliases="none"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>Commence field name 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="4" aliases="none"> <maml:name>Qualifier</maml:name> <maml:description> <maml:para>Specify how to match.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Contains</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DoesNotContain</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">On</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">At</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EqualTo</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotEqualTo</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LessThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GreaterThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Between</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">True</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">False</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Checked</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotChecked</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">No</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Before</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">After</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Blank</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Shared</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Local</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">One</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Zero</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">FilterQualifier</command:parameterValue> <dev:type> <maml:name>FilterQualifier</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>FieldValue</maml:name> <maml:description> <maml:para>Field value to match 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="6" aliases="none"> <maml:name>FieldValue2</maml:name> <maml:description> <maml:para>Field value to match on in case of a `Between` filter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Except</maml:name> <maml:description> <maml:para>Invert filter.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MatchCase</maml:name> <maml:description> <maml:para>Match case sensitive.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrFilter</maml:name> <maml:description> <maml:para>Set filter conjunction to OR (if omitted, defaults to AND).</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>Connected 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="0" aliases="none"> <maml:name>ClauseNumber</maml:name> <maml:description> <maml:para>Position of the filter (1-8).</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="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Connection</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Except</maml:name> <maml:description> <maml:para>Invert filter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>Commence field name 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="5" aliases="none"> <maml:name>FieldValue</maml:name> <maml:description> <maml:para>Field value to match 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="6" aliases="none"> <maml:name>FieldValue2</maml:name> <maml:description> <maml:para>Field value to match on in case of a `Between` filter.</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.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrFilter</maml:name> <maml:description> <maml:para>Set filter conjunction to OR (if omitted, defaults to AND).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Qualifier</maml:name> <maml:description> <maml:para>Specify how to match.</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.CursorFilterCTCF</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>The object-based approach to filtering in `Vovin.CmcLibNet` does not require setting the filter conjunction after the fact like you would when using the Commence RM API directly. You set the conjunction in the filter itself. It defaults to 'AND', use the `-OrFilter` switch for 'OR'. That will 'OR' the filters coming afterward, according to Commence's special grouping of filters, where for example 'OR' in filter 3 will 'OR' filter 4, but 'OR' in filter 4 will 'OR' the group of filters 5 to 8. The grouping is as follows: `[ [ [1] AndOr [2] ] AndOr [ [3] AndOr [4] ] ] AndOr [ [ [5] AndOr [6] ] AndOr [ [7] AndOr [8] ] ]`. Have fun and good luck!</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-CmcFilterCTCF 1 'Relates to' Contact lastName EqualTo Douglas -MatchCase</dev:code> <dev:remarks> <maml:para>(Assumes Tutorial database , category 'Account') Set filter 1 to get items in 'Account' that have connected items in connection 'Relates to' to category 'Contact' where field 'lastName' is equal to string 'Douglas', case-sensitive.</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-CmcFilterCTCTI</command:name> <command:verb>Get</command:verb> <command:noun>CmcFilterCTCTI</command:noun> <maml:description> <maml:para>Get filter on connection to connected item.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a Connection To Connected To Item (CTCTI) Filter. Filters for items in A that have connected items in B that have a connection to an item X in C.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcFilterCTCTI</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>Filter clause number (1-8).</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="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Primary 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>Category</maml:name> <maml:description> <maml:para>Primary connected 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="3" aliases="none"> <maml:name>Connection2</maml:name> <maml:description> <maml:para>Secondary 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="4" aliases="none"> <maml:name>Category2</maml:name> <maml:description> <maml:para>Secondary 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="5" aliases="none"> <maml:name>Item</maml:name> <maml:description> <maml:para>Item to filter on in secondary connected 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="named" aliases="none"> <maml:name>Except</maml:name> <maml:description> <maml:para>Invert filter.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrFilter</maml:name> <maml:description> <maml:para>Set filter conjunction to OR (if omitted, defaults to AND).</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>Primary connected 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="4" aliases="none"> <maml:name>Category2</maml:name> <maml:description> <maml:para>Secondary 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="0" aliases="none"> <maml:name>ClauseNumber</maml:name> <maml:description> <maml:para>Filter clause number (1-8).</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="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Primary 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="3" aliases="none"> <maml:name>Connection2</maml:name> <maml:description> <maml:para>Secondary 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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Except</maml:name> <maml:description> <maml:para>Invert filter.</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="5" aliases="none"> <maml:name>Item</maml:name> <maml:description> <maml:para>Item to filter on in secondary connected 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="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: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.CursorFilterCTCTI</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Does not yet support clarified item names.</maml:para> <maml:para>The object-based approach to filtering in `Vovin.CmcLibNet` does not require setting the filter conjunction after the fact like you would when using the Commence RM API directly. You set the conjunction in the filter itself. It defaults to 'AND', use the `-OrFilter` switch for 'OR'. That will 'OR' the filters coming afterward, according to Commence's special grouping of filters, where for example 'OR' in filter 3 will 'OR' filter 4, but 'OR' in filter 4 will 'OR' the group of filters 5 to 8. The grouping is as follows: `[ [ [1] AndOr [2] ] AndOr [ [3] AndOr [4] ] ] AndOr [ [ [5] AndOr [6] ] AndOr [ [7] AndOr [8] ] ]`. Have fun and good luck!</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-CmcFilterCTCTI 1 'Relates to' History 'Relates to' Contact 'Findlay.Howard'</dev:code> <dev:remarks> <maml:para>(Assumes Tutorial database , category 'Account') Filter for items that have a connection to 'History' that have a connection to 'Contact' item 'Findlay.Howard'. Both connection names are called 'Relates to', that is just coincidence, they are different connections.</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-CmcFilterCTI</command:name> <command:verb>Get</command:verb> <command:noun>CmcFilterCTI</command:noun> <maml:description> <maml:para>Get filter for items connected to an item.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a Connection To Item (CTI) filter. Filters for items in A that have a connection to item X in B.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcFilterCTI</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>Filter clause number (1-8).</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="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Connection</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>Category</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="3" aliases="none"> <maml:name>Item</maml:name> <maml:description> <maml:para>Connected item value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Except</maml:name> <maml:description> <maml:para>Invert filter.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrFilter</maml:name> <maml:description> <maml:para>Set filter conjunction to OR (if omitted, defaults to AND).</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Category</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="0" aliases="none"> <maml:name>ClauseNumber</maml:name> <maml:description> <maml:para>Filter clause number (1-8).</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="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Connection</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Except</maml:name> <maml:description> <maml:para>Invert filter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Item</maml:name> <maml:description> <maml:para>Connected item value.</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>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: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.CursorFilterCTI</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Does not yet support clarified item names.</maml:para> <maml:para>The object-based approach to filtering in `Vovin.CmcLibNet` does not require setting the filter conjunction after the fact like you would when using the Commence RM API directly. You set the conjunction in the filter itself. It defaults to 'AND', use the `-OrFilter` switch for 'OR'. That will 'OR' the filters coming afterward, according to Commence's special grouping of filters, where for example 'OR' in filter 3 will 'OR' filter 4, but 'OR' in filter 4 will 'OR' the group of filters 5 to 8. The grouping is as follows: `[ [ [1] AndOr [2] ] AndOr [ [3] AndOr [4] ] ] AndOr [ [ [5] AndOr [6] ] AndOr [ [7] AndOr [8] ] ]`. Have fun and good luck!</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-CmcFilterCTI 1 'Relates to' Contact 'Findlay.Howard'</dev:code> <dev:remarks> <maml:para>(Assumes Tutorial database , category 'Account') Filter for items that have a connection to 'Contact' item 'Findlay.Howard'.</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-CmcFilterF</command:name> <command:verb>Get</command:verb> <command:noun>CmcFilterF</command:noun> <maml:description> <maml:para>Get filter on a field value.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a Field (F) filter. Filters for a field value.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcFilterF</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>Filter clause number (1-8).</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="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>Commence field name to 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="False" position="2" aliases="none"> <maml:name>Qualifier</maml:name> <maml:description> <maml:para>Filter qualifier (i.e. the filter condition).</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Contains</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DoesNotContain</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">On</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">At</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EqualTo</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotEqualTo</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LessThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GreaterThan</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Between</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">True</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">False</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Checked</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotChecked</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yes</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">No</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Before</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">After</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Blank</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Shared</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Local</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">One</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Zero</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">FilterQualifier</command:parameterValue> <dev:type> <maml:name>FilterQualifier</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>FieldValue</maml:name> <maml:description> <maml:para>Field value to filter 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>FieldValue2</maml:name> <maml:description> <maml:para>Second field value to filter for in case of a `Between` filter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Except</maml:name> <maml:description> <maml:para>Invert filter.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MatchCase</maml:name> <maml:description> <maml:para>Match string case-sensitive. Applies only to text-fields.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrFilter</maml:name> <maml:description> <maml:para>Set filter conjunction to OR (if omitted, defaults to AND).</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ClauseNumber</maml:name> <maml:description> <maml:para>Filter clause number (1-8).</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.</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="none"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>Commence field name to 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="False" position="3" aliases="none"> <maml:name>FieldValue</maml:name> <maml:description> <maml:para>Field value to filter 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:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>FieldValue2</maml:name> <maml:description> <maml:para>Second field value to filter for in case of a `Between` filter.</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 string case-sensitive. Applies only to text-fields.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrFilter</maml:name> <maml:description> <maml:para>Set filter conjunction to OR (if omitted, defaults to AND).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Qualifier</maml:name> <maml:description> <maml:para>Filter qualifier (i.e. the filter condition).</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.CursorFilterF</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>The object-based approach to filtering in `Vovin.CmcLibNet` does not require setting the filter conjunction after the fact like you would when using the Commence RM API directly. You set the conjunction in the filter itself. It defaults to 'AND', use the `-OrFilter` switch for 'OR'. That will 'OR' the filters coming afterward, according to Commence's special grouping of filters, where for example 'OR' in filter 3 will 'OR' filter 4, but 'OR' in filter 4 will 'OR' the group of filters 5 to 8. The grouping is as follows: `[ [ [1] AndOr [2] ] AndOr [ [3] AndOr [4] ] ] AndOr [ [ [5] AndOr [6] ] AndOr [ [7] AndOr [8] ] ]`. Have fun and good luck!</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-CmcFilterF 1 accountKey Between 'A' 'B'</dev:code> <dev:remarks> <maml:para>(Assumes Tutorial database , category 'Account') Filter for items where the 'accontKey' field is between 'A' and 'B'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-CmcFilterF 1 accountKey [Vovin.CmcLibNet.Database.FilterQualifier]::Contains 'A'</dev:code> <dev:remarks> <maml:para>(Assumes Tutorial database , category 'Account') Filter for items where the 'accontKey' field contains 'A'. Uses the fully qualified FilterQualifier value.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-CmcFilterF 1 accountKey 0 'A'</dev:code> <dev:remarks> <maml:para>Identical to Example 2, but uses the numeric value of the FilterQualifier.</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-CmcFilterQualifiers</command:name> <command:verb>Get</command:verb> <command:noun>CmcFilterQualifiers</command:noun> <maml:description> <maml:para>Get Commence FilterQuilifiers</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the values from the `Vovin.CmcLibNet.Datase.FilterQualifier` enum.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcFilterQualifiers</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>Vovin.CmcLibNet.Datase.FilterQualifier</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-CmcFilterQualifiers</dev:code> <dev:remarks> <maml:para>Gets the values from the `Vovin.CmcLibNet.Datase.FilterQualifier` enum.</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-CmcLastDDEError</command:name> <command:verb>Get</command:verb> <command:noun>CmcLastDDEError</command:noun> <maml:description> <maml:para>Get last DDE error thrown in Commence</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use this if you want to see the last DDE error thrown in Commence, for example when you try to read or write data via DDE (don't do that :).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcLastDDEError</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>You can also just look at the log file.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-CmcLastDDEError</dev:code> <dev:remarks> <maml:para>Gets last DDE error</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-CmcRelatedColumn</command:name> <command:verb>Get</command:verb> <command:noun>CmcRelatedColumn</command:noun> <maml:description> <maml:para>Get a related column.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a related column definition for use in `Get-CmcFieldValues`.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CmcRelatedColumn</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="none"> <maml:name>ToCategory</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 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 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="none"> <maml:name>ToCategory</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.RelatedColumn</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-CmcRelatedColumn '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> <maml:navigationLink> <maml:linkText>Get-CmcFieldValues</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="none"> <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="False" 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="none"> <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="False" 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>This cmdlet tests if the filter is syntactically valid. That is, it tests if it technically works , not if it returns anything meaningful.</maml:para> <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> <maml:navigationLink> <maml:linkText>Get-CmcFilterF</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CmcFilterCTI</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CmcFilterCTCF</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CmcFilterCTCTI</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |