ISHRemote.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: New-IshDitaGeneralizedXml --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-IshDitaGeneralizedXml</command:name> <command:verb>New</command:verb> <command:noun>IshDitaGeneralizedXml</command:noun> <maml:description> <maml:para>The New-IshDitaGeneralizedXml cmdlet generalizes all files that are passed through the pipeline or via the -FilePath parameter. Both the specialized input xml file and resulting generalized xml output file are validated. Note that a DOCTYPE needs to be present in the input xml file and resulting generalized xml output file are validated.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-IshDitaGeneralizedXml cmdlet generalizes all files that are passed through the pipeline or via the -FilePath parameter. Both the specialized input xml file and resulting generalized xml output file are validated. Note that a DOCTYPE needs to be present in the input xml file and resulting generalized xml output file are validated.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: FilesGroup --> <command:syntaxItem> <maml:name>New-IshDitaGeneralizedXml</maml:name> <!-- Parameter: SpecializedCatalogLocation --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SpecializedCatalogLocation</maml:name> <maml:description> <maml:para>The filepath of the catalog with the specialized DTDs. Best is to make a separate folders with all the specialized DTD files together + a catalog with relative locations to the specialized DTD files.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GeneralizedCatalogLocation --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GeneralizedCatalogLocation</maml:name> <maml:description> <maml:para>The filepath of the catalog with the generalized/standard DTDs. Best is to make a separate folders with all the generalized DTD files together + a catalog with relative locations to the generalized DTD files.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GeneralizationCatalogMappingLocation --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GeneralizationCatalogMappingLocation</maml:name> <maml:description> <maml:para>The location of a generalization mapping file. This mapping file defines the relation between the specialized dtd rootelements/public ids and the corresponding generalized dtd rootelements/public ids. It is of the following form: <generalizationcataloglookup> <match rootelement="learningSummary" dtdpublicid="-//OASIS//DTD DITA Learning Summary//EN" generalizedrootelement="topic" generalizeddtdpublicid="-//OASIS//DTD DITA Topic//EN" generalizeddtdsystemid="dita-oasis/1.1/topic.dtd" /> <match rootelement="learningContent" generalizedrootelement="topic" generalizeddtdpublicid="-//OASIS//DTD DITA Topic//EN" generalizeddtdsystemid="dita-oasis/1.1/topic.dtd" /> ... </generalizationcataloglookup> The rootelement, dtdpublicid or dtdsystemid attributes are used to match the specialized xml rootelement or dtd, while the generalizedrootelement, generalizeddtdpublicid or generalizeddtdsystemid are used to specify the corresponding generalized rootelement/dtd. Note that: 1) At least one of the specialized attributes is required 2) The generalizedrootelement is required 3) Either the generalizeddtdpublicid or generalizeddtdsystemid is required</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AttributesToGeneralizeToProps --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AttributesToGeneralizeToProps</maml:name> <maml:description> <maml:para>Array of attributes that are specialized from the DITA "props" attribute (and need to be generalized to it).</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AttributesToGeneralizeToBase --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AttributesToGeneralizeToBase</maml:name> <maml:description> <maml:para>Array of attributes that are specialized from the DITA "base" attribute (and need to be generalized to it).</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: File --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Files"> <maml:name>File</maml:name> <maml:description> <maml:para>Array of FileInfo objects that is passed through the pipeline. This parameter holds the specialized xml input files to generalize.</maml:para> </maml:description> <command:parameterValue required="true">FileInfo[]</command:parameterValue> <dev:type> <maml:name>System.IO.FileInfo[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FileLocationGroup --> <command:syntaxItem> <maml:name>New-IshDitaGeneralizedXml</maml:name> <!-- Parameter: SpecializedCatalogLocation --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SpecializedCatalogLocation</maml:name> <maml:description> <maml:para>The filepath of the catalog with the specialized DTDs. Best is to make a separate folders with all the specialized DTD files together + a catalog with relative locations to the specialized DTD files.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GeneralizedCatalogLocation --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GeneralizedCatalogLocation</maml:name> <maml:description> <maml:para>The filepath of the catalog with the generalized/standard DTDs. Best is to make a separate folders with all the generalized DTD files together + a catalog with relative locations to the generalized DTD files.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GeneralizationCatalogMappingLocation --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GeneralizationCatalogMappingLocation</maml:name> <maml:description> <maml:para>The location of a generalization mapping file. This mapping file defines the relation between the specialized dtd rootelements/public ids and the corresponding generalized dtd rootelements/public ids. It is of the following form: <generalizationcataloglookup> <match rootelement="learningSummary" dtdpublicid="-//OASIS//DTD DITA Learning Summary//EN" generalizedrootelement="topic" generalizeddtdpublicid="-//OASIS//DTD DITA Topic//EN" generalizeddtdsystemid="dita-oasis/1.1/topic.dtd" /> <match rootelement="learningContent" generalizedrootelement="topic" generalizeddtdpublicid="-//OASIS//DTD DITA Topic//EN" generalizeddtdsystemid="dita-oasis/1.1/topic.dtd" /> ... </generalizationcataloglookup> The rootelement, dtdpublicid or dtdsystemid attributes are used to match the specialized xml rootelement or dtd, while the generalizedrootelement, generalizeddtdpublicid or generalizeddtdsystemid are used to specify the corresponding generalized rootelement/dtd. Note that: 1) At least one of the specialized attributes is required 2) The generalizedrootelement is required 3) Either the generalizeddtdpublicid or generalizeddtdsystemid is required</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AttributesToGeneralizeToProps --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AttributesToGeneralizeToProps</maml:name> <maml:description> <maml:para>Array of attributes that are specialized from the DITA "props" attribute (and need to be generalized to it).</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AttributesToGeneralizeToBase --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AttributesToGeneralizeToBase</maml:name> <maml:description> <maml:para>Array of attributes that are specialized from the DITA "base" attribute (and need to be generalized to it).</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="FileLocation"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>FilePath can be used to specify one specialized input xml file location.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SpecializedCatalogLocation --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SpecializedCatalogLocation</maml:name> <maml:description> <maml:para>The filepath of the catalog with the specialized DTDs. Best is to make a separate folders with all the specialized DTD files together + a catalog with relative locations to the specialized DTD files.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GeneralizedCatalogLocation --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GeneralizedCatalogLocation</maml:name> <maml:description> <maml:para>The filepath of the catalog with the generalized/standard DTDs. Best is to make a separate folders with all the generalized DTD files together + a catalog with relative locations to the generalized DTD files.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GeneralizationCatalogMappingLocation --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>GeneralizationCatalogMappingLocation</maml:name> <maml:description> <maml:para>The location of a generalization mapping file. This mapping file defines the relation between the specialized dtd rootelements/public ids and the corresponding generalized dtd rootelements/public ids. It is of the following form: <generalizationcataloglookup> <match rootelement="learningSummary" dtdpublicid="-//OASIS//DTD DITA Learning Summary//EN" generalizedrootelement="topic" generalizeddtdpublicid="-//OASIS//DTD DITA Topic//EN" generalizeddtdsystemid="dita-oasis/1.1/topic.dtd" /> <match rootelement="learningContent" generalizedrootelement="topic" generalizeddtdpublicid="-//OASIS//DTD DITA Topic//EN" generalizeddtdsystemid="dita-oasis/1.1/topic.dtd" /> ... </generalizationcataloglookup> The rootelement, dtdpublicid or dtdsystemid attributes are used to match the specialized xml rootelement or dtd, while the generalizedrootelement, generalizeddtdpublicid or generalizeddtdsystemid are used to specify the corresponding generalized rootelement/dtd. Note that: 1) At least one of the specialized attributes is required 2) The generalizedrootelement is required 3) Either the generalizeddtdpublicid or generalizeddtdsystemid is required</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AttributesToGeneralizeToProps --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AttributesToGeneralizeToProps</maml:name> <maml:description> <maml:para>Array of attributes that are specialized from the DITA "props" attribute (and need to be generalized to it).</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AttributesToGeneralizeToBase --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AttributesToGeneralizeToBase</maml:name> <maml:description> <maml:para>Array of attributes that are specialized from the DITA "base" attribute (and need to be generalized to it).</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="FileLocation"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>FilePath can be used to specify one specialized input xml file location.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="FileLocation"> <maml:name>FileLocation</maml:name> <maml:description> <maml:para>FilePath can be used to specify one specialized input xml file location.</maml:para> <maml:para>This is an alias of the FilePath parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: File --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Files"> <maml:name>File</maml:name> <maml:description> <maml:para>Array of FileInfo objects that is passed through the pipeline. This parameter holds the specialized xml input files to generalize.</maml:para> </maml:description> <command:parameterValue required="true">FileInfo[]</command:parameterValue> <dev:type> <maml:name>System.IO.FileInfo[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Files"> <maml:name>Files</maml:name> <maml:description> <maml:para>Array of FileInfo objects that is passed through the pipeline. This parameter holds the specialized xml input files to generalize.</maml:para> <maml:para>This is an alias of the File parameter.</maml:para> </maml:description> <command:parameterValue required="true">FileInfo[]</command:parameterValue> <dev:type> <maml:name>System.IO.FileInfo[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.IO.FileInfo[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array of FileInfo objects that is passed through the pipeline. This parameter holds the specialized xml input files to generalize.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: FileInfo --> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code># This sample script will process all DITA xml files in the input folder and will generalize all DITA files either to Topic or Map. # Note that ditabase and ditaval are not supported. # Note that the xmls in the input folder needs to have a DOCTYPE. Write-Host "Setting current directory..." [string]$currentScriptDirectory = split-path -parent $MyInvocation.MyCommand.Definition Set-Location $currentScriptDirectory [Environment]::CurrentDirectory=$currentScriptDirectory # Input folder with the specialized xmls to generalize. $inputfolder = "Data-GeneralizeDitaXml\InputFiles" # Output folder with the generalize xmls. The successfully generalized files will get a .gen extension, the failed ones will get .err with a .log file next to them why they failed. $outputfolder = "Data-GeneralizeDitaXml\OutputFiles" # !This folder will be deleted if it already exists! # Location of the catalog xml that contains the specialized dtds $specializedCatalogLocation = "Data-GeneralizeDitaXml\SpecializedDTDs\catalog-alldita12dtds.xml" # Location of the catalog xml that contains the "base" dtds $generalizedCatalogLocation = "Data-GeneralizeDitaXml\GeneralizedDTDs\catalog-dita12topic&maponly.xml"; # File that contains a mapping between the specialized dtd and the according generalized dtd. $generalizationCatalogMappingLocation = "Data-GeneralizeDitaXml\generalization-catalog-mapping.xml" # If you would have specialized attributes from the DITA 1.2 "props" attribute, specify those attributes here to generalize them to the "props" attribute again. Here just using modelyear, market, vehicle as an example $attributesToGeneralizeToProps = @("modelA", "modelB", "modelC") # If you would have specialized attributes from the DITA 1.2 "base" attribute, specify those attributes here to generalize them to the "base" attribute again. Here just using basea, baseb, basec as an example $attributesToGeneralizeToBase = @("basea", "baseb", "basec") if (Test-Path $outputfolder) { Remove-Item $outputfolder -Recurse } # First we will copy all the files of the inputfolder to the outputfolder recursively Copy-Item -Path $inputfolder -Destination $outputfolder -recurse -force # Read all the xml files to process from the outputfolder $filesToProcess = get-childItem $outputfolder -include *.xml -recurse # Generalize all the files in the outputfolder # The successfully generalized files will get a .gen extension, the failed ones will get .err with a .log file next to them why they failed. $filesToProcess | New-IshDitaGeneralizedXml ` -SpecializedCatalogLocation $SpecializedCatalogLocation ` -GeneralizedCatalogLocation $GeneralizedCatalogLocation ` -GeneralizationCatalogMappingLocation $GeneralizationCatalogMappingLocation ` -AttributesToGeneralizeToProps $attributesToGeneralizeToProps ` -AttributesToGeneralizeToBase $attributesToGeneralizeToBase</dev:code> <dev:remarks> <maml:para>Generalize all DITA xml files in a certain directory</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>$generalizesamplesrootfolder = "C:\\temp\\"; $specializedCatalogLocation = $generalizesamplesrootfolder + "SpecializedDTDs\\catalog-dita-1.2.xml"; $generalizedCatalogLocation = $generalizesamplesrootfolder + "GeneralizedDTDs\\catalog-dita-1.1.xml"; $generalizationCatalogMappingLocation = $generalizesamplesrootfolder + "generalization-catalog-mapping.xml"; $attributesToGeneralizeToProps = @("complexity", "visibility") # array containing 2 elements $attributesToGeneralizeToBase = @(); # @() = empty array New-IshDitaGeneralizedXml -SpecializedCatalogLocation $SpecializedCatalogLocation ` -GeneralizedCatalogLocation $GeneralizedCatalogLocation ` -GeneralizationCatalogMappingLocation $GeneralizationCatalogMappingLocation ` -FilePath $FilePath ` -AttributesToGeneralizeToProps $attributesToGeneralizeToProps ` -AttributesToGeneralizeToBase $attributesToGeneralizeToBase</dev:code> <dev:remarks> <maml:para>Generalize one DITA xml file</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-IshDocumentObj --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-IshDocumentObj</command:name> <command:verb>Add</command:verb> <command:noun>IshDocumentObj</command:noun> <maml:description> <maml:para>The Add-IshDocumentObj cmdlet adds the new document object(s) (which include illustrations) that are passed through the pipeline or determined via provided parameters This commandlet allows to create all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Add-IshPublicationOutput.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-IshDocumentObj cmdlet adds the new document object(s) (which include illustrations) that are passed through the pipeline or determined via provided parameters This commandlet allows to create all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Add-IshPublicationOutput.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroupFilePath --> <command:syntaxItem> <maml:name>Add-IshDocumentObj</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>The FolderId of the DocumentObj.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>The FolderId of the DocumentObj by IshFolder object</maml:para> </maml:description> <command:parameterValue required="true">IshFolder</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder</maml:name> <maml:uri /> <maml:description> <maml:para>Generic pipeline object for the Folder API holding folder reference like "ishfolderref", "ishfoldertype", "ishfields"</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshType</maml:name> <maml:description> <maml:para>The IshType.</maml:para> <maml:para>Possible values: ISHNone, ISHNotFound, ISHModule, ISHMasterDoc, ISHLibrary, ISHTemplate, ISHIllustration, ISHPublication, ISHUser, ISHUserGroup, ISHUserRole, ISHBaseline, ISHOutputFormat, ISHEDT, ISHFolder, ISHTranslationJob, ISHConfiguration, ISHRevision, ISHFeatures</maml:para> </maml:description> <command:parameterValue required="true">ISHType</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ISHType</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration of all possible object types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>ISHNone</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ISHNone</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHNotFound</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHModule</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHMasterDoc</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHLibrary</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHTemplate</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHIllustration</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHPublication</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHUserGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHUserRole</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHBaseline</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHOutputFormat</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHEDT</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHFolder</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHTranslationJob</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHConfiguration</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHRevision</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHFeatures</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The LogicalId of the DocumentObj.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>GUID-A745BDB0-22E1-4108-ADDD-B2D3575BE4C3</dev:defaultValue> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Version of the DocumentObj.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>NEW</dev:defaultValue> </command:parameter> <!-- Parameter: Lng --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Lng</maml:name> <maml:description> <maml:para>The Language of the DocumentObj.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Resolution --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resolution</maml:name> <maml:description> <maml:para>The Resolution of the DocumentObj.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata of the DocumentObj.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Edt --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Edt</maml:name> <maml:description> <maml:para>The unique identifier of the Electronic Document Type for the content (e.g. EDTPDF, EDTXML, EDTHTML,...) of the new object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EDTXML</dev:defaultValue> </command:parameter> <!-- Parameter: FilePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>The path to the file containing data for the DocumentObj</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ParameterGroupFileContent --> <command:syntaxItem> <maml:name>Add-IshDocumentObj</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>The FolderId of the DocumentObj.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>The FolderId of the DocumentObj by IshFolder object</maml:para> </maml:description> <command:parameterValue required="true">IshFolder</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder</maml:name> <maml:uri /> <maml:description> <maml:para>Generic pipeline object for the Folder API holding folder reference like "ishfolderref", "ishfoldertype", "ishfields"</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshType</maml:name> <maml:description> <maml:para>The IshType.</maml:para> <maml:para>Possible values: ISHNone, ISHNotFound, ISHModule, ISHMasterDoc, ISHLibrary, ISHTemplate, ISHIllustration, ISHPublication, ISHUser, ISHUserGroup, ISHUserRole, ISHBaseline, ISHOutputFormat, ISHEDT, ISHFolder, ISHTranslationJob, ISHConfiguration, ISHRevision, ISHFeatures</maml:para> </maml:description> <command:parameterValue required="true">ISHType</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ISHType</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration of all possible object types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>ISHNone</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ISHNone</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHNotFound</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHModule</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHMasterDoc</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHLibrary</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHTemplate</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHIllustration</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHPublication</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHUserGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHUserRole</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHBaseline</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHOutputFormat</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHEDT</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHFolder</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHTranslationJob</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHConfiguration</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHRevision</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHFeatures</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The LogicalId of the DocumentObj.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>GUID-2BED43D2-207D-41B0-A228-62EA7B3361B2</dev:defaultValue> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Version of the DocumentObj.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>NEW</dev:defaultValue> </command:parameter> <!-- Parameter: Lng --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Lng</maml:name> <maml:description> <maml:para>The Language of the DocumentObj.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Resolution --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resolution</maml:name> <maml:description> <maml:para>The Resolution of the DocumentObj.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata of the DocumentObj.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Edt --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Edt</maml:name> <maml:description> <maml:para>The unique identifier of the Electronic Document Type for the content (e.g. EDTPDF, EDTXML, EDTHTML,...) of the new object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EDTXML</dev:defaultValue> </command:parameter> <!-- Parameter: FileContent --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FileContent</maml:name> <maml:description> <maml:para>String with XML content of the DocumentObj</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Add-IshDocumentObj</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>The FolderId of the DocumentObj.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>The FolderId of the DocumentObj by IshFolder object</maml:para> </maml:description> <command:parameterValue required="true">IshFolder</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder</maml:name> <maml:uri /> <maml:description> <maml:para>Generic pipeline object for the Folder API holding folder reference like "ishfolderref", "ishfoldertype", "ishfields"</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>The IshObjectss that need to be added.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>The FolderId of the DocumentObj.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>The FolderId of the DocumentObj by IshFolder object</maml:para> </maml:description> <command:parameterValue required="true">IshFolder</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder</maml:name> <maml:uri /> <maml:description> <maml:para>Generic pipeline object for the Folder API holding folder reference like "ishfolderref", "ishfoldertype", "ishfields"</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshType</maml:name> <maml:description> <maml:para>The IshType.</maml:para> <maml:para>Possible values: ISHNone, ISHNotFound, ISHModule, ISHMasterDoc, ISHLibrary, ISHTemplate, ISHIllustration, ISHPublication, ISHUser, ISHUserGroup, ISHUserRole, ISHBaseline, ISHOutputFormat, ISHEDT, ISHFolder, ISHTranslationJob, ISHConfiguration, ISHRevision, ISHFeatures</maml:para> </maml:description> <command:parameterValue required="true">ISHType</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ISHType</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration of all possible object types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>ISHNone</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ISHNone</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHNotFound</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHModule</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHMasterDoc</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHLibrary</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHTemplate</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHIllustration</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHPublication</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHUser</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHUserGroup</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHUserRole</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHBaseline</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHOutputFormat</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHEDT</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHFolder</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHTranslationJob</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHConfiguration</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHRevision</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHFeatures</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The LogicalId of the DocumentObj.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>GUID-3D0D161A-FDCD-4A77-9E4B-0E97387113DF</dev:defaultValue> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Version of the DocumentObj.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>NEW</dev:defaultValue> </command:parameter> <!-- Parameter: Lng --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Lng</maml:name> <maml:description> <maml:para>The Language of the DocumentObj.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Resolution --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resolution</maml:name> <maml:description> <maml:para>The Resolution of the DocumentObj.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata of the DocumentObj.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Edt --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Edt</maml:name> <maml:description> <maml:para>The unique identifier of the Electronic Document Type for the content (e.g. EDTPDF, EDTXML, EDTHTML,...) of the new object.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EDTXML</dev:defaultValue> </command:parameter> <!-- Parameter: FilePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>The path to the file containing data for the DocumentObj</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FileContent --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FileContent</maml:name> <maml:description> <maml:para>String with XML content of the DocumentObj</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>The IshObjectss that need to be added.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The IshObjectss that need to be added.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "" -IshUserPassword "" Write-Host "`r`nCreate a logical, version, language level" $ditaFileContent = @" <? xml version="1.0" ?> <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> <topic><title>Enter the title of your topic here.<? ish-replace-title?></title><shortdesc>Enter a short description of your topic here(optional).</shortdesc><body><p>This is the start of your topic.</p></body></topic> "@ $ishMetadataFields = Set-IshMetadataField -IshSession $ishSession -Name "FTITLE" -Level "Logical" -Value "Example ISHModule" | Set-IshMetadataField -IshSession $ishSession -Name "FCHANGES" -Level "Version" -Value "Changes text field" | Set-IshMetadataField -IshSession $ishSession -Name "FSTATUS" -Level "Lng" -Value "Draft" | Set-IshMetadataField -IshSession $ishSession -Name "FAUTHOR" -Level "Lng" -Value "admin" # add object $ishObject = Add-IshDocumentObj -IshSession $ishSession ` -FolderId "0" ` -IshType "ISHModule" ` -Lng "en" ` -Metadata $ishMetadataFields ` -Edt "EDTXML" ` -FileContent $ditaFileContent $ishObject.ObjectRef| Format-Table</dev:code> <dev:remarks> <maml:para>Add Module without providing LogicalId, Version and using FileContent parameter</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "" -IshUserPassword "" Write-Host "`r`nCreate a logical, version, language level" $timestamp = get-date -Format "yyyyMMddHHmmss" $logicalId = "MYGUID-$timestamp" $ditaFilePath = "c:\temp\Task.dita" # Template which is used to create a language level $ishMetadataFields = Set-IshMetadataField -IshSession $ishSession -Name "FTITLE" -Level "Logical" -Value "Example ISHModule" ` | Set-IshMetadataField -IshSession $ishSession -Name "FCHANGES" -Level "Version" -Value "Changes text field" ` | Set-IshMetadataField -IshSession $ishSession -Name "FSTATUS" -Level "Lng" -Value "Draft" ` | Set-IshMetadataField -IshSession $ishSession -Name "FAUTHOR" -Level "Lng" -Value "admin" # add object $ishObject = Add-IshDocumentObj -IshSession $ishSession ` -FolderId "0" ` #use valid FolderId -LogicalId $logicalId ` -IshType "ISHModule" ` -Version "1" ` -Lng "en" ` -Metadata $ishMetadataFields ` -Edt "EDTXML" ` -FilePath $ditaFilePath $ishObject.ObjectRef| Format-Table</dev:code> <dev:remarks> <maml:para>Add Module with providing LogicalId and Version</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "" -IshUserPassword "" Write-Host "`r`nCreate a logical, version, language level" $ditaFilePath = "c:\temp\Task.dita" # Template which is used to create a language level $ishMetadataFields = Set-IshMetadataField -IshSession $ishSession -Name "FTITLE" -Level "Logical" -Value "Example ISHModule" ` | Set-IshMetadataField -IshSession $ishSession -Name "FCHANGES" -Level "Version" -Value "Changes text field" ` | Set-IshMetadataField -IshSession $ishSession -Name "FSTATUS" -Level "Lng" -Value "Draft" ` | Set-IshMetadataField -IshSession $ishSession -Name "FAUTHOR" -Level "Lng" -Value "admin" # add object $ishObject = Add-IshDocumentObj -IshSession $ishSession ` -FolderId "0" ` #use valid FolderId -IshType "ISHModule" ` -Lng "en" ` -Metadata $ishMetadataFields ` -Edt "EDTXML" ` -FilePath $ditaFilePath $ishObject.ObjectRef| Format-Table</dev:code> <dev:remarks> <maml:para>Add Module without providing LogicalId and Version</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Find-IshDocumentObj --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Find-IshDocumentObj</command:name> <command:verb>Find</command:verb> <command:noun>IshDocumentObj</command:noun> <maml:description> <maml:para>The Find-IshDocumentObj cmdlet finds document objects (which include illustrations) using MetadataFilter, TypeFilter and StatusFilter that are provided This commandlet allows to find all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Find-IshPublicationOutput.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Find-IshDocumentObj cmdlet finds document objects (which include illustrations) using MetadataFilter, TypeFilter and StatusFilter that are provided This commandlet allows to find all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Find-IshPublicationOutput.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Find-IshDocumentObj</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshTypeFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshTypeFilter</maml:name> <maml:description> <maml:para>The folder type filter to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">ISHType[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ISHType[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StatusFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StatusFilter</maml:name> <maml:description> <maml:para>The status type filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: ISHReleasedStates, ISHReleasedOrDraftStates, ISHOutOfDateOrReleasedStates, ISHNoStatusFilter</maml:para> </maml:description> <command:parameterValue required="true">StatusFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+StatusFilter</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration matching the API status filters for IshObjects</maml:para> </maml:description> </dev:type> <dev:defaultValue>ISHNoStatusFilter</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ISHReleasedStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHReleasedOrDraftStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHOutOfDateOrReleasedStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHNoStatusFilter</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshTypeFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshTypeFilter</maml:name> <maml:description> <maml:para>The folder type filter to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">ISHType[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ISHType[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StatusFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StatusFilter</maml:name> <maml:description> <maml:para>The status type filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: ISHReleasedStates, ISHReleasedOrDraftStates, ISHOutOfDateOrReleasedStates, ISHNoStatusFilter</maml:para> </maml:description> <command:parameterValue required="true">StatusFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+StatusFilter</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration matching the API status filters for IshObjects</maml:para> </maml:description> </dev:type> <dev:defaultValue>ISHNoStatusFilter</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ISHReleasedStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHReleasedOrDraftStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHOutOfDateOrReleasedStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHNoStatusFilter</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-IshDocumentObj --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-IshDocumentObj</command:name> <command:verb>Get</command:verb> <command:noun>IshDocumentObj</command:noun> <maml:description> <maml:para>Retrieves the metadata and optionally blob of document objects</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets IshObject entries through logical id filtering or language card ids, optionally providing the blob.</maml:para> <maml:para>Uses DocumentObj25 API to retrieve ishobjects.</maml:para> <maml:para>The Get-IshDocumentObj cmdlet retrieves metadata of the document objects that are passed through the pipeline or determined via provided parameters. This commandlet allows to retrieve all types of objects(Illustrations, Maps, etc. ), except for publication(outputs). For publication(outputs) you need to use Get-IshPublicationOutput.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Get-IshDocumentObj</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The logical identifiers of the document objects for which to retrieve the metadata</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StatusFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StatusFilter</maml:name> <maml:description> <maml:para>The status filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: ISHReleasedStates, ISHReleasedOrDraftStates, ISHOutOfDateOrReleasedStates, ISHNoStatusFilter</maml:para> </maml:description> <command:parameterValue required="true">StatusFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+StatusFilter</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration matching the API status filters for IshObjects</maml:para> </maml:description> </dev:type> <dev:defaultValue>ISHNoStatusFilter</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ISHReleasedStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHReleasedOrDraftStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHOutOfDateOrReleasedStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHNoStatusFilter</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IncludeData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeData</maml:name> <maml:description> <maml:para>Switch patameter that specifies if the return objects should hold the blob (ishdata) sections, potentially conditionally published if IshFeature was passed</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IshFeature --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshFeature</maml:name> <maml:description> <maml:para>The condition context to use for conditional filtering. If no context is provided, the elements containing ishcondition attributes will always remain in the data content. You can use the Set-IshFeature cmdlet to create a condition context.</maml:para> </maml:description> <command:parameterValue required="true">IshFeature[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFeature[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Get-IshDocumentObj</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StatusFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StatusFilter</maml:name> <maml:description> <maml:para>The status filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: ISHReleasedStates, ISHReleasedOrDraftStates, ISHOutOfDateOrReleasedStates, ISHNoStatusFilter</maml:para> </maml:description> <command:parameterValue required="true">StatusFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+StatusFilter</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration matching the API status filters for IshObjects</maml:para> </maml:description> </dev:type> <dev:defaultValue>ISHNoStatusFilter</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ISHReleasedStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHReleasedOrDraftStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHOutOfDateOrReleasedStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHNoStatusFilter</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IncludeData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeData</maml:name> <maml:description> <maml:para>Switch patameter that specifies if the return objects should hold the blob (ishdata) sections, potentially conditionally published if IshFeature was passed</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IshFeature --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshFeature</maml:name> <maml:description> <maml:para>The condition context to use for conditional filtering. If no context is provided, the elements containing ishcondition attributes will always remain in the data content. You can use the Set-IshFeature cmdlet to create a condition context.</maml:para> </maml:description> <command:parameterValue required="true">IshFeature[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFeature[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the objects for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The logical identifiers of the document objects for which to retrieve the metadata</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StatusFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StatusFilter</maml:name> <maml:description> <maml:para>The status filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: ISHReleasedStates, ISHReleasedOrDraftStates, ISHOutOfDateOrReleasedStates, ISHNoStatusFilter</maml:para> </maml:description> <command:parameterValue required="true">StatusFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+StatusFilter</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration matching the API status filters for IshObjects</maml:para> </maml:description> </dev:type> <dev:defaultValue>ISHNoStatusFilter</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ISHReleasedStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHReleasedOrDraftStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHOutOfDateOrReleasedStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHNoStatusFilter</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IncludeData --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeData</maml:name> <maml:description> <maml:para>Switch patameter that specifies if the return objects should hold the blob (ishdata) sections, potentially conditionally published if IshFeature was passed</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IshFeature --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshFeature</maml:name> <maml:description> <maml:para>The condition context to use for conditional filtering. If no context is provided, the elements containing ishcondition attributes will always remain in the data content. You can use the Set-IshFeature cmdlet to create a condition context.</maml:para> </maml:description> <command:parameterValue required="true">IshFeature[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFeature[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the objects for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the objects for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Move-IshDocumentObj --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Move-IshDocumentObj</command:name> <command:verb>Move</command:verb> <command:noun>IshDocumentObj</command:noun> <maml:description> <maml:para>The Move-IshDocumentObj cmdlet moves document objects that are passed through the pipeline or determined via provided parameters from one repository folder to another folder. This commandlet allows to move all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Move-IshPublicationOutput.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Move-IshDocumentObj cmdlet moves document objects that are passed through the pipeline or determined via provided parameters from one repository folder to another folder. This commandlet allows to move all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Move-IshPublicationOutput.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Move-IshDocumentObj</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The logical identifiers of the document objects to move</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FromFolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FromFolderId</maml:name> <maml:description> <maml:para>The folder identifier where the objects are currently located</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: FromIshFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FromIshFolder</maml:name> <maml:description> <maml:para>The IshFolder object where the objects are currently located</maml:para> </maml:description> <command:parameterValue required="true">IshFolder</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder</maml:name> <maml:uri /> <maml:description> <maml:para>Generic pipeline object for the Folder API holding folder reference like "ishfolderref", "ishfoldertype", "ishfields"</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ToFolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ToFolderId</maml:name> <maml:description> <maml:para>The folder identifier where to move the document objects to</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-2</dev:defaultValue> </command:parameter> <!-- Parameter: ToIshFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ToIshFolder</maml:name> <maml:description> <maml:para>The IshFolder object where to move the document objects to</maml:para> </maml:description> <command:parameterValue required="true">IshFolder</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder</maml:name> <maml:uri /> <maml:description> <maml:para>Generic pipeline object for the Folder API holding folder reference like "ishfolderref", "ishfoldertype", "ishfields"</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Move-IshDocumentObj</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FromFolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FromFolderId</maml:name> <maml:description> <maml:para>The folder identifier where the objects are currently located</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: FromIshFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FromIshFolder</maml:name> <maml:description> <maml:para>The IshFolder object where the objects are currently located</maml:para> </maml:description> <command:parameterValue required="true">IshFolder</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder</maml:name> <maml:uri /> <maml:description> <maml:para>Generic pipeline object for the Folder API holding folder reference like "ishfolderref", "ishfoldertype", "ishfields"</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ToFolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ToFolderId</maml:name> <maml:description> <maml:para>The folder identifier where to move the document objects to</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-2</dev:defaultValue> </command:parameter> <!-- Parameter: ToIshFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ToIshFolder</maml:name> <maml:description> <maml:para>The IshFolder object where to move the document objects to</maml:para> </maml:description> <command:parameterValue required="true">IshFolder</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder</maml:name> <maml:uri /> <maml:description> <maml:para>Generic pipeline object for the Folder API holding folder reference like "ishfolderref", "ishfoldertype", "ishfields"</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the object to move. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The logical identifiers of the document objects to move</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FromFolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FromFolderId</maml:name> <maml:description> <maml:para>The folder identifier where the objects are currently located</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: FromIshFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FromIshFolder</maml:name> <maml:description> <maml:para>The IshFolder object where the objects are currently located</maml:para> </maml:description> <command:parameterValue required="true">IshFolder</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder</maml:name> <maml:uri /> <maml:description> <maml:para>Generic pipeline object for the Folder API holding folder reference like "ishfolderref", "ishfoldertype", "ishfields"</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ToFolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ToFolderId</maml:name> <maml:description> <maml:para>The folder identifier where to move the document objects to</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-2</dev:defaultValue> </command:parameter> <!-- Parameter: ToIshFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ToIshFolder</maml:name> <maml:description> <maml:para>The IshFolder object where to move the document objects to</maml:para> </maml:description> <command:parameterValue required="true">IshFolder</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder</maml:name> <maml:uri /> <maml:description> <maml:para>Generic pipeline object for the Folder API holding folder reference like "ishfolderref", "ishfoldertype", "ishfields"</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the object to move. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the object to move. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Remove-IshDocumentObj --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-IshDocumentObj</command:name> <command:verb>Remove</command:verb> <command:noun>IshDocumentObj</command:noun> <maml:description> <maml:para>The Remove-IshDocumentObj cmdlet removes the document objects that are passed through the pipeline or determined via provided parameters This commandlet allows to remove all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Remove-IshPublicationOutput.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-IshDocumentObj cmdlet removes the document objects that are passed through the pipeline or determined via provided parameters This commandlet allows to remove all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Remove-IshPublicationOutput.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Remove-IshDocumentObj</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The logical identifier of the document object</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version of the document object</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Lng --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Lng</maml:name> <maml:description> <maml:para>The language of the document object</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Resolution --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resolution</maml:name> <maml:description> <maml:para>The resolution of the document object</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the document object. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</maml:para> <maml:para>If the metadata is still the same, the document object is removed.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the document object is not removed.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>When the Force switch is set, after deleting the language object, the version object and logical object will be deleted if they don't have any language objects anymore</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Remove-IshDocumentObj</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the document object. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</maml:para> <maml:para>If the metadata is still the same, the document object is removed.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the document object is not removed.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the objects to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>When the Force switch is set, after deleting the language object, the version object and logical object will be deleted if they don't have any language objects anymore</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The logical identifier of the document object</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version of the document object</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Lng --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Lng</maml:name> <maml:description> <maml:para>The language of the document object</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Resolution --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resolution</maml:name> <maml:description> <maml:para>The resolution of the document object</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the document object. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</maml:para> <maml:para>If the metadata is still the same, the document object is removed.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the document object is not removed.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the objects to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>When the Force switch is set, after deleting the language object, the version object and logical object will be deleted if they don't have any language objects anymore</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the objects to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Set-IshDocumentObj --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-IshDocumentObj</command:name> <command:verb>Set</command:verb> <command:noun>IshDocumentObj</command:noun> <maml:description> <maml:para>The Set-IshDocumentObj cmdlet updates the document objects that are passed through the pipeline or determined via provided parameters This commandlet allows to update all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Set-IshPublicationOutput.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-IshDocumentObj cmdlet updates the document objects that are passed through the pipeline or determined via provided parameters This commandlet allows to update all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Set-IshPublicationOutput.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Set-IshDocumentObj</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The logical identifier of the object to update</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version of the object to update</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Lng --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Lng</maml:name> <maml:description> <maml:para>The language of the object to update</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Resolution --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resolution</maml:name> <maml:description> <maml:para>The resolution of the object to update</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata to set for the document object</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the document object. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</maml:para> <maml:para>If the metadata is still the same, the metadata will be set.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the metadata will be set.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Edt --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Edt</maml:name> <maml:description> <maml:para>The unique identifier of the Electronic Document Type of the output (e.g. EDTPDF, EDTXML, EDTHTML,...)</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>The location of the file on the filesystem containing new content (xml, jpg, etc.) for the object</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Set-IshDocumentObj</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the document object. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</maml:para> <maml:para>If the metadata is still the same, the metadata will be set.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the metadata will be set.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the objects for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The logical identifier of the object to update</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version of the object to update</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Lng --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Lng</maml:name> <maml:description> <maml:para>The language of the object to update</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Resolution --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resolution</maml:name> <maml:description> <maml:para>The resolution of the object to update</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata to set for the document object</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the document object. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</maml:para> <maml:para>If the metadata is still the same, the metadata will be set.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the metadata will be set.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Edt --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Edt</maml:name> <maml:description> <maml:para>The unique identifier of the Electronic Document Type of the output (e.g. EDTPDF, EDTXML, EDTHTML,...)</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>The location of the file on the filesystem containing new content (xml, jpg, etc.) for the object</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the objects for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the objects for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-IshDocumentObjData --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-IshDocumentObjData</command:name> <command:verb>Get</command:verb> <command:noun>IshDocumentObjData</command:noun> <maml:description> <maml:para>The Get-IshDocumentObjData cmdlet retrieves the data/blob of the document objects that are passed through the pipeline or determined via provided parameters and saves them to the given Windows folder. This commandlet allows to retrieve all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Get-IshPublicationOutputData.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-IshDocumentObjData cmdlet retrieves the data/blob of the document objects that are passed through the pipeline or determined via provided parameters and saves them to the given Windows folder. This commandlet allows to retrieve all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Get-IshPublicationOutputData.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-IshDocumentObjData</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the objects for which to retrieve the data. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder on the Windows filesystem where to store the retrieved data files</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshFeature --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshFeature</maml:name> <maml:description> <maml:para>The condition context to use for conditional filtering. If no context is provided, the elements containing ishcondition attributes will always remain in the data content. You can use the Set-IshFeature cmdlet to create a condition context.</maml:para> </maml:description> <command:parameterValue required="true">IshFeature[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFeature[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the objects for which to retrieve the data. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder on the Windows filesystem where to store the retrieved data files</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshFeature --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshFeature</maml:name> <maml:description> <maml:para>The condition context to use for conditional filtering. If no context is provided, the elements containing ishcondition attributes will always remain in the data content. You can use the Set-IshFeature cmdlet to create a condition context.</maml:para> </maml:description> <command:parameterValue required="true">IshFeature[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFeature[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the objects for which to retrieve the data. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: FileInfo --> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $ishMetadataFilterFields = Set-IshMetadataFilterField -IshSession $ishSession -Name "FTITLE" -Level "Logical" -FilterOperator "Like" -Value "%topic%" | Set-IshMetadataFilterField -IshSession $ishSession -Name "FAUTHOR" -Level "Lng" -FilterOperator "Equal" -Value "admin" | Set-IshMetadataFilterField -IshSession $ishSession -Name "FSTATUS" -Level "Lng" -FilterOperator "Equal" -Value "To be translated" $ishRequestedFields = Set-IshRequestedMetadataField -IshSession $ishSession -Name "FTITLE" -Level "logical" | Set-IshRequestedMetadataField -IshSession $ishSession -Name "VERSION" -Level "version" | Set-IshRequestedMetadataField -IshSession $ishSession -Name "DOC-LANGUAGE" -Level "lng" $fileList = Find-IshDocumentObj -IshSession $ishSession -MetadataFilter $ishMetadataFilterFields ` -IshTypeFilter "ISHModule" ` -RequestedMetadata $ishRequestedFields | Get-IshDocumentObjData -IshSession $ishSession ` -FolderPath "c:\temp\export"</dev:code> <dev:remarks> <maml:para>Download modules to a temp location</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-IshDocumentObjFolderLocation --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-IshDocumentObjFolderLocation</command:name> <command:verb>Get</command:verb> <command:noun>IshDocumentObjFolderLocation</command:noun> <maml:description> <maml:para>The Get-IshDocumentObjFolderLocation cmdlet returns the repository location of a document object in a form of a separated string e.g. "General\Folder1\Folder2" This commandlet allows to retrieve the location of all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Get-IshPublicationOutputFolderLocation.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-IshDocumentObjFolderLocation cmdlet returns the repository location of a document object in a form of a separated string e.g. "General\Folder1\Folder2" This commandlet allows to retrieve the location of all types of objects (Illustrations, Maps, etc. ), except for publication (outputs). For publication (outputs) you need to use Get-IshPublicationOutputFolderLocation.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Get-IshDocumentObjFolderLocation</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The LogicalId of the DocumentObj object</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectGroup --> <command:syntaxItem> <maml:name>Get-IshDocumentObjFolderLocation</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Object for which to retrieve the folder location. This object can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The LogicalId of the DocumentObj object</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Object for which to retrieve the folder location. This object can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object for which to retrieve the folder location. This object can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $folderPath = Get-IshDocumentObjFolderLocation -IshSession $ishSession -LogicalId "GUID-8C8F01ED-9785-47DE-9A00-1F8AAFD94E7D"</dev:code> <dev:remarks> <maml:para>Retrieve location of the DocumentObj</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-IshEDT --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-IshEDT</command:name> <command:verb>Add</command:verb> <command:noun>IshEDT</command:noun> <maml:description> <maml:para>The Add-IshEDT cmdlet adds the new EDTs that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-IshEDT cmdlet adds the new EDTs that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Add-IshEDT</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name for the new EDT</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>MetaData - xml structure that will be used for the new EDT</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Add-IshEDT</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>IshObject - contains EDT data that needs to be created. Pipeline</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name for the new EDT</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>MetaData - xml structure that will be used for the new EDT</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>IshObject - contains EDT data that needs to be created. Pipeline</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>IshObject - contains EDT data that needs to be created. Pipeline</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metadata = Set-IshMetadataField -IshSession $ishSession -Name "EDT-CANDIDATE" -Level "none" -Value "XML" | Set-IshMetadataField -IshSession $ishSession -Name "EDT-FILE-EXTENSION" -Level "none" -Value "XML" | Set-IshMetadataField -IshSession $ishSession -Name "EDT-MIME-TYPE" -Level "none" -Value "text/xml" $edt = Add-IshEDT -IshSession $ishSession -Name "MYEDT" -Metadata $metadata</dev:code> <dev:remarks> <maml:para>Add a new EDT</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Find-IshEDT --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Find-IshEDT</command:name> <command:verb>Find</command:verb> <command:noun>IshEDT</command:noun> <maml:description> <maml:para>The Find-IshEDT cmdlet finds EDT objects using ActivityFilter and MetadataFilter that are provided</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Find-IshEDT cmdlet finds EDT objects using ActivityFilter and MetadataFilter that are provided</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Find-IshEDT</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $ishMetadataFilterFields = Set-IshMetadataFilterField -IshSession $ishSession -Name "EDT-FILE-EXTENSION" -Level "None" -FilterOperator "Like" -Value "%xml%" $ishRequestedFields = Set-IshRequestedMetadataField -IshSession $ishSession -Name "NAME" -Level "None" $edtList = Find-IshEDT -IshSession $ishSession ` -ActivityFilter "None" ` -MetadataFilter $ishMetadataFilterFields ` -RequestedMetadata $ishRequestedFields</dev:code> <dev:remarks> <maml:para>Find EDTs with names containing "edt" text</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-IshEDT --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-IshEDT</command:name> <command:verb>Get</command:verb> <command:noun>IshEDT</command:noun> <maml:description> <maml:para>The Get-IshEDT cmdlet retrieves the metadata of the EDTs that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-IshEDT cmdlet retrieves the metadata of the EDTs that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Get-IshEDT</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id - string array with IDs of the EDTs</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Get-IshEDT</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the objects for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id - string array with IDs of the EDTs</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the objects for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the objects for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metadata = Set-IshMetadataField -IshSession $ishSession -Name "EDT-CANDIDATE" -Level "none" -Value "XML" | Set-IshMetadataField -IshSession $ishSession -Name "EDT-FILE-EXTENSION" -Level "none" -Value "XML" | Set-IshMetadataField -IshSession $ishSession -Name "EDT-MIME-TYPE" -Level "none" -Value "text/xml" $edt = Add-IshEDT -IshSession $ishSession ` -Name "MYEDT" ` -Metadata $metadata $edtId = $edt[0].IshRef $ishRequestedFields = Set-IshRequestedMetadataField -IshSession $ishSession -Name "NAME" -Level "None" $edtRetrieve = Get-IshEDT -IshSession $ishSession ` -Id @($edtId) ` -ActivityFilter "None" ` -RequestedMetadata $ishRequestedFields</dev:code> <dev:remarks> <maml:para>Retrieve Name of added EDT</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-IshEDT --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-IshEDT</command:name> <command:verb>Remove</command:verb> <command:noun>IshEDT</command:noun> <maml:description> <maml:para>The Remove-IshEDT cmdlet removes the EDTs that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-IshEDT cmdlet removes the EDTs that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Remove-IshEDT</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id - element name of the EDT to be removed</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Remove-IshEDT</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>The IshObject array containing EDTs that needs to be deleted. Pipeline</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id - element name of the EDT to be removed</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>The IshObject array containing EDTs that needs to be deleted. Pipeline</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The IshObject array containing EDTs that needs to be deleted. Pipeline</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metadata = Set-IshMetadataField -IshSession $ishSession -Name "EDT-CANDIDATE" -Level "none" -Value "XML" | Set-IshMetadataField -IshSession $ishSession -Name "EDT-FILE-EXTENSION" -Level "none" -Value "XML" | Set-IshMetadataField -IshSession $ishSession -Name "EDT-MIME-TYPE" -Level "none" -Value "text/xml" $edt = Add-IshEDT -IshSession $ishSession ` -Name "MYEDT" ` -Metadata $metadata #Remove EDT using pipeline $edt | Remove-IshEDT -IshSession $ishSession</dev:code> <dev:remarks> <maml:para>Remove added EDT</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-IshEDT --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-IshEDT</command:name> <command:verb>Set</command:verb> <command:noun>IshEDT</command:noun> <maml:description> <maml:para>The Set-IshEDT cmdlet updates the EDTs that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-IshEDT cmdlet updates the EDTs that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Set-IshEDT</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>EDT Element Name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata to set for the object</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the object. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</maml:para> <maml:para>If the metadata is still the same, the metadata will be set.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the metadata will be set.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Set-IshEDT</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the object. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</maml:para> <maml:para>If the metadata is still the same, the metadata will be set.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the metadata will be set.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the objects for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>EDT Element Name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata to set for the object</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the object. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</maml:para> <maml:para>If the metadata is still the same, the metadata will be set.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the metadata will be set.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the objects for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the objects for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $edtName = "MYEDT" $metadata = Set-IshMetadataField -IshSession $ishSession -Name "EDT-CANDIDATE" -Level "none" -Value "XML" | Set-IshMetadataField -IshSession $ishSession -Name "EDT-FILE-EXTENSION" -Level "none" -Value "XML" | Set-IshMetadataField -IshSession $ishSession -Name "EDT-MIME-TYPE" -Level "none" -Value "text/xml" $edtAdd = Add-IshEDT -IshSession $ishSession -Name $edtName -Metadata $metadata $metadataUpdate = Set-IshMetadataField -IshSession $ishSession -Name "NAME" -Level "none" -Value ($edtName + " updated") $requiredCurrentMetadata = Set-IshRequiredCurrentMetadataField -IshSession $ishSession -Name "EDT-FILE-EXTENSION" -Level "none" -Value "XML" Set-IshEDT -IshSession $ishSession -RequiredCurrentMetadata $requiredCurrentMetadata -Metadata $metadataUpdate</dev:code> <dev:remarks> <maml:para>Add EDT and update name</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" Set-IshEDT -IshSession $ishSession -Id EDTXML -Metadata (Set-IshMetadataField -IshSession $ishSession -Name "EDT-CANDIDATE" -Level None -ValueType Value -Value "xml, dita, ditamap")</dev:code> <dev:remarks> <maml:para>Adding .map and .ditamap to the EDTXML object. By adding these, tools like Content-Importer/DITA2Trisoft can import .xml, .dita and .ditamap files and they will all be assigned EDTXML as Electronic Document Type.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-IshEvent --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-IshEvent</command:name> <command:verb>Get</command:verb> <command:noun>IshEvent</command:noun> <maml:description> <maml:para>Gets EventMonitor entries with filtering options.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uses EventMonitor25 API to retrieve ishevents showing progress of background task events from the centralized log system.</maml:para> <maml:para>This table oriented API maps straight through to database column names regarding ishfield usage.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Get-IshEvent</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: EventTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EventTypes</maml:name> <maml:description> <maml:para>String array containing the event types to retrieve (e.g. EXPORTFORPUBLICATION, PUSHTRANSLATIONS,...)</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProgressStatusFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProgressStatusFilter</maml:name> <maml:description> <maml:para>The enumeration indicating which overall status the event must have (e.g. All, Success, Failed,...)</maml:para> <maml:para>Possible values: Busy, Success, Warning, Failed, All</maml:para> </maml:description> <command:parameterValue required="true">ProgressStatusFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ProgressStatusFilter</maml:name> <maml:uri /> <maml:description> <maml:para>EventMonitor Events Status Filter</maml:para> </maml:description> </dev:type> <dev:defaultValue>All</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Busy</command:parameterValue> <command:parameterValue required="false" variableLength="false">Success</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Failed</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ModifiedSince --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ModifiedSince</maml:name> <maml:description> <maml:para>A date limiting the events that will be retrieved based on the last modification date of the events</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>13/10/2016 0:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: UserFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserFilter</maml:name> <maml:description> <maml:para>Enumeration indicating if only events of the current user or all events must be retrieved</maml:para> <maml:para>Possible values: Current, All</maml:para> </maml:description> <command:parameterValue required="true">UserFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+UserFilter</maml:name> <maml:uri /> <maml:description> <maml:para>EventMonitor Events User Filter</maml:para> </maml:description> </dev:type> <dev:defaultValue>All</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Current</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>Filter on metadata to limit the objects on which metadata has to be returned</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>XML structure indicating which metadata has to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EventLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EventLevel</maml:name> <maml:description> <maml:para>Possible values for the level of an event detail.</maml:para> <maml:para>Possible values: Exception, Warning, Configuration, Information, Verbose, Debug</maml:para> </maml:description> <command:parameterValue required="true">EventLevel</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+EventLevel</maml:name> <maml:uri /> <maml:description> <maml:para>Possible values for the level of an event detail</maml:para> </maml:description> </dev:type> <dev:defaultValue>Exception</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Exception</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Configuration</command:parameterValue> <command:parameterValue required="false" variableLength="false">Information</command:parameterValue> <command:parameterValue required="false" variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshEventsGroup --> <command:syntaxItem> <maml:name>Get-IshEvent</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>Filter on metadata to limit the objects on which metadata has to be returned</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>XML structure indicating which metadata has to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EventLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EventLevel</maml:name> <maml:description> <maml:para>Possible values for the level of an event detail.</maml:para> <maml:para>Possible values: Exception, Warning, Configuration, Information, Verbose, Debug</maml:para> </maml:description> <command:parameterValue required="true">EventLevel</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+EventLevel</maml:name> <maml:uri /> <maml:description> <maml:para>Possible values for the level of an event detail</maml:para> </maml:description> </dev:type> <dev:defaultValue>Exception</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Exception</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Configuration</command:parameterValue> <command:parameterValue required="false" variableLength="false">Information</command:parameterValue> <command:parameterValue required="false" variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IshEvent --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshEvent</maml:name> <maml:description> <maml:para>The IshEvents that need to be handled.</maml:para> </maml:description> <command:parameterValue required="true">IshEvent[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshEvent[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: EventTypes --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EventTypes</maml:name> <maml:description> <maml:para>String array containing the event types to retrieve (e.g. EXPORTFORPUBLICATION, PUSHTRANSLATIONS,...)</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProgressStatusFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProgressStatusFilter</maml:name> <maml:description> <maml:para>The enumeration indicating which overall status the event must have (e.g. All, Success, Failed,...)</maml:para> <maml:para>Possible values: Busy, Success, Warning, Failed, All</maml:para> </maml:description> <command:parameterValue required="true">ProgressStatusFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ProgressStatusFilter</maml:name> <maml:uri /> <maml:description> <maml:para>EventMonitor Events Status Filter</maml:para> </maml:description> </dev:type> <dev:defaultValue>All</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Busy</command:parameterValue> <command:parameterValue required="false" variableLength="false">Success</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Failed</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ModifiedSince --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ModifiedSince</maml:name> <maml:description> <maml:para>A date limiting the events that will be retrieved based on the last modification date of the events</maml:para> </maml:description> <command:parameterValue required="true">DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>13/10/2016 0:00:00</dev:defaultValue> </command:parameter> <!-- Parameter: UserFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserFilter</maml:name> <maml:description> <maml:para>Enumeration indicating if only events of the current user or all events must be retrieved</maml:para> <maml:para>Possible values: Current, All</maml:para> </maml:description> <command:parameterValue required="true">UserFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+UserFilter</maml:name> <maml:uri /> <maml:description> <maml:para>EventMonitor Events User Filter</maml:para> </maml:description> </dev:type> <dev:defaultValue>All</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Current</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>Filter on metadata to limit the objects on which metadata has to be returned</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>XML structure indicating which metadata has to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EventLevel --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EventLevel</maml:name> <maml:description> <maml:para>Possible values for the level of an event detail.</maml:para> <maml:para>Possible values: Exception, Warning, Configuration, Information, Verbose, Debug</maml:para> </maml:description> <command:parameterValue required="true">EventLevel</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+EventLevel</maml:name> <maml:uri /> <maml:description> <maml:para>Possible values for the level of an event detail</maml:para> </maml:description> </dev:type> <dev:defaultValue>Exception</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Exception</command:parameterValue> <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" variableLength="false">Configuration</command:parameterValue> <command:parameterValue required="false" variableLength="false">Information</command:parameterValue> <command:parameterValue required="false" variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IshEvent --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshEvent</maml:name> <maml:description> <maml:para>The IshEvents that need to be handled.</maml:para> </maml:description> <command:parameterValue required="true">IshEvent[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshEvent[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshEvent[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The IshEvents that need to be handled.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshEvent --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshEvent</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The IshEvent is one entry on the EventMonitor detail are, also holding progress top-level information.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$requestedMetadata = Set-IshRequestedMetadataField -IshSession $ishSession -Name "EVENTID" -Level "Progress" | Set-IshRequestedMetadataField -IshSession $ishSession -Name "EVENTTYPE" -Level "Progress" Get-IshEvent -IshSession $ishSession -EventTypes @("EXPORTFORPUBLICATION","SYNCHRONIZETOLIVECONTENT") -RequestedMetadata $requestedMetadata</dev:code> <dev:remarks> <maml:para>Gets all top-level (progress) ishevents filtered to publish and synchronize events.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>$requestedMetadata = Set-IshRequestedMetadataField -IshSession $ishSession -Name "EVENTID" -Level "Progress" | Set-IshRequestedMetadataField -IshSession $ishSession -Name "EVENTTYPE" -Level "Progress" | Set-IshRequestedMetadataField -IshSession $ishSession -Name "EVENTDATATYPE" -Level "Detail" $metadataFilter = Set-IshMetadataFilterField -IshSession $ishSession -Name "EVENTDATATYPE" -Level "Detail" -FilterOperator "NotEqual" -Value "10" Get-IshEvent -IshSession $ishSession -EventTypes @("EXPORTFORPUBLICATION","SYNCHRONIZETOLIVECONTENT") -RequestedMetadata $requestedMetadata -MetadataFilter $metadataFilter</dev:code> <dev:remarks> <maml:para>Gets up to detail ishevents filtered to publish and synchronize events and the eventdatatype should differ from 10.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>$requestedMetadata = Set-IshRequestedMetadataField -IshSession $ishSession -Name "EVENTID" -Level "Progress" | Set-IshRequestedMetadataField -IshSession $ishSession -Name "EVENTTYPE" -Level "Progress" | Set-IshRequestedMetadataField -IshSession $ishSession -Name "EVENTDATATYPE" -Level "Detail" $metadataFilter = Set-IshMetadataFilterField -IshSession $ishSession -Name "ACTION" -Level "Detail" -FilterOperator In -Value "Request started, Start execution, Execution completed" Get-IshEvent -IshSession $ishSession -EventTypes @("EXPORTFORPUBLICATION") -RequestedMetadata $requestedMetadata -MetadataFilter $metadataFilter</dev:code> <dev:remarks> <maml:para>Gets up to detail ishevents filtered to publish events and filters to only have the queue event, processing started and processing ended. This allows calculation of lead times and through put.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-IshFeature --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-IshFeature</command:name> <command:verb>Set</command:verb> <command:noun>IshFeature</command:noun> <maml:description> <maml:para>The Set-IshFeature cmdlet creates a new IshFeature based on the parameters provided. When IshFeature[] object is passed through the pipeline then the new feature is added based on the parameters provided</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-IshFeature cmdlet creates a new IshFeature based on the parameters provided. When IshFeature[] object is passed through the pipeline then the new feature is added based on the parameters provided</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-IshFeature</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The condition name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>The condition value</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshFeature --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshFeature</maml:name> <maml:description> <maml:para>The set of condition names and values</maml:para> </maml:description> <command:parameterValue required="true">IshFeature[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFeature[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The condition name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>The condition value</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshFeature --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshFeature</maml:name> <maml:description> <maml:para>The set of condition names and values</maml:para> </maml:description> <command:parameterValue required="true">IshFeature[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFeature[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFeature[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The set of condition names and values</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshFeature --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFeature</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Stores a single feature part of the context that will be used as input by ConditionFilter to make an @ishcondition true. For example BLUETOOTH=Y</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Set-IshField --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-IshField</command:name> <command:verb>Set</command:verb> <command:noun>IshField</command:noun> <maml:description> <maml:para>The Set-IshField cmdlet sets/merges the IshFields * If an IshObject[] array parameter is provided (either explicit or via the pipeline), the MergeFields are merged according to the ValueAction parameter to all the IshFields of all the objects, and the objects are returned * If an IshFields object is provided (either explicit or via the pipeline), the MergeFields are merged according to the ValueAction parameter to the IshFields object and the resulting fields are returned * If none of the above applies, the fields in the MergeFields are returned</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-IshField cmdlet sets/merges the IshFields * If an IshObject[] array parameter is provided (either explicit or via the pipeline), the MergeFields are merged according to the ValueAction parameter to all the IshFields of all the objects, and the objects are returned * If an IshFields object is provided (either explicit or via the pipeline), the MergeFields are merged according to the ValueAction parameter to the IshFields object and the resulting fields are returned * If none of the above applies, the fields in the MergeFields are returned Best practice is to supply IshSession for future functionality.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Set-IshField</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: MergeField --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MergeField</maml:name> <maml:description> <maml:para>The IshField[] to merge</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueAction</maml:name> <maml:description> <maml:para>Whether the fields in the mergefields parameter will be prepended, appended or overwrite the values in the provided IshFields or IshObject objects</maml:para> <maml:para>Possible values: Overwrite, Prepend, Append</maml:para> </maml:description> <command:parameterValue required="true">ValueAction</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ValueAction</maml:name> <maml:uri /> <maml:description> <maml:para>If two fields should be first, should the second value overwrite the first or prepend/append it</maml:para> </maml:description> </dev:type> <dev:defaultValue>Append</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Overwrite</command:parameterValue> <command:parameterValue required="false" variableLength="false">Prepend</command:parameterValue> <command:parameterValue required="false" variableLength="false">Append</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Objects to merge the fields in</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshFieldGroup --> <command:syntaxItem> <maml:name>Set-IshField</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: MergeField --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MergeField</maml:name> <maml:description> <maml:para>The IshField[] to merge</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueAction</maml:name> <maml:description> <maml:para>Whether the fields in the mergefields parameter will be prepended, appended or overwrite the values in the provided IshFields or IshObject objects</maml:para> <maml:para>Possible values: Overwrite, Prepend, Append</maml:para> </maml:description> <command:parameterValue required="true">ValueAction</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ValueAction</maml:name> <maml:uri /> <maml:description> <maml:para>If two fields should be first, should the second value overwrite the first or prepend/append it</maml:para> </maml:description> </dev:type> <dev:defaultValue>Append</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Overwrite</command:parameterValue> <command:parameterValue required="false" variableLength="false">Prepend</command:parameterValue> <command:parameterValue required="false" variableLength="false">Append</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IshField --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshField</maml:name> <maml:description> <maml:para>Fields to merge the mergefields in</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: MergeField --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MergeField</maml:name> <maml:description> <maml:para>The IshField[] to merge</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueAction --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueAction</maml:name> <maml:description> <maml:para>Whether the fields in the mergefields parameter will be prepended, appended or overwrite the values in the provided IshFields or IshObject objects</maml:para> <maml:para>Possible values: Overwrite, Prepend, Append</maml:para> </maml:description> <command:parameterValue required="true">ValueAction</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ValueAction</maml:name> <maml:uri /> <maml:description> <maml:para>If two fields should be first, should the second value overwrite the first or prepend/append it</maml:para> </maml:description> </dev:type> <dev:defaultValue>Append</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Overwrite</command:parameterValue> <command:parameterValue required="false" variableLength="false">Prepend</command:parameterValue> <command:parameterValue required="false" variableLength="false">Append</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Objects to merge the fields in</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshField --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshField</maml:name> <maml:description> <maml:para>Fields to merge the mergefields in</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Objects to merge the fields in</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Fields to merge the mergefields in</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshField --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Holds one field metadata entry described by a name, optional level and value</maml:para> </maml:description> </command:returnValue> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Add-IshFolder --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-IshFolder</command:name> <command:verb>Add</command:verb> <command:noun>IshFolder</command:noun> <maml:description> <maml:para>The Add-IshFolder cmdlet adds the new folders that are passed through the pipeline or determined via provided parameters. Query and Reference folders are not supported.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-IshFolder cmdlet adds the new folders that are passed through the pipeline or determined via provided parameters. Query and Reference folders are not supported.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Add-IshFolder</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ParentFolderId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ParentFolderId</maml:name> <maml:description> <maml:para>The identifier of the parent folder where the new folder will be created</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: FolderType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderType</maml:name> <maml:description> <maml:para>The Type of the new Folder</maml:para> <maml:para>Possible values: ISHNone, ISHModule, ISHMasterDoc, ISHLibrary, ISHTemplate, ISHIllustration, ISHPublication, ISHReference, ISHQuery</maml:para> </maml:description> <command:parameterValue required="true">IshFolderType</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+IshFolderType</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration of folder types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>ISHNone</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ISHNone</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHModule</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHMasterDoc</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHLibrary</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHTemplate</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHIllustration</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHPublication</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHReference</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHQuery</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: FolderName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderName</maml:name> <maml:description> <maml:para>The Name of the new Folder</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OwnedBy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OwnedBy</maml:name> <maml:description> <maml:para>The name of the UserGroup that will be the owner of the new folder</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReadAccess --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReadAccess</maml:name> <maml:description> <maml:para>Array with the UserGroups that have ReadAccess to the new folder</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshFoldersGroup --> <command:syntaxItem> <maml:name>Add-IshFolder</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ParentFolderId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ParentFolderId</maml:name> <maml:description> <maml:para>The identifier of the parent folder where the new folder will be created</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>The IshFolder array that needs to be created. Pipeline</maml:para> </maml:description> <command:parameterValue required="true">IshFolder[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ParentFolderId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ParentFolderId</maml:name> <maml:description> <maml:para>The identifier of the parent folder where the new folder will be created</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: FolderType --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderType</maml:name> <maml:description> <maml:para>The Type of the new Folder</maml:para> <maml:para>Possible values: ISHNone, ISHModule, ISHMasterDoc, ISHLibrary, ISHTemplate, ISHIllustration, ISHPublication, ISHReference, ISHQuery</maml:para> </maml:description> <command:parameterValue required="true">IshFolderType</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+IshFolderType</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration of folder types.</maml:para> </maml:description> </dev:type> <dev:defaultValue>ISHNone</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ISHNone</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHModule</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHMasterDoc</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHLibrary</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHTemplate</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHIllustration</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHPublication</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHReference</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHQuery</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: FolderName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderName</maml:name> <maml:description> <maml:para>The Name of the new Folder</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OwnedBy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OwnedBy</maml:name> <maml:description> <maml:para>The name of the UserGroup that will be the owner of the new folder</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReadAccess --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReadAccess</maml:name> <maml:description> <maml:para>Array with the UserGroups that have ReadAccess to the new folder</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>The IshFolder array that needs to be created. Pipeline</maml:para> </maml:description> <command:parameterValue required="true">IshFolder[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The IshFolder array that needs to be created. Pipeline</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshFolder --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the Folder API holding folder reference like "ishfolderref", "ishfoldertype", "ishfields"</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $folderName = "New folder created by powershell" $parentFolderId = "7775" # provide a valid parent folder Id $ishFolders = Add-IshFolder -IshSession $ishSession ` -ParentFolderId $parentFolderId ` -FolderType "ISHModule" ` -FolderName $folderName ` -ReadAccess @("") ` -OwnedBy ""</dev:code> <dev:remarks> <maml:para>Add a folder using input parameters</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-IshFolder --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-IshFolder</command:name> <command:verb>Get</command:verb> <command:noun>IshFolder</command:noun> <maml:description> <maml:para>The Get-IshFolder cmdlet retrieves metadata for the folders by providing one of the following input data: - FolderPath string with the separated full folder path - FolderIds array containing identifiers of the folders - BaseFolder enum value referencing the specified root folder - IshFolder[] array passed through the pipeline Query and Reference folders are not supported.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-IshFolder cmdlet retrieves metadata for the folders by providing one of the following input data: - FolderPath string with the separated full folder path - FolderIds array containing identifiers of the folders - BaseFolder enum value referencing the specified root folder - IshFolder[] array passed through the pipeline Query and Reference folders are not supported.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: FolderIdGroup --> <command:syntaxItem> <maml:name>Get-IshFolder</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>Unique folder identifier</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Perform recursive retrieval of the provided incoming folder(s)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Depth --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Perform recursive retrieval of up to Depth of the provided incoming folder(s)</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2147483647</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: FolderPathGroup --> <command:syntaxItem> <maml:name>Get-IshFolder</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Separated string with the full folder path, e.g. "General\Project\Topics"</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Perform recursive retrieval of the provided incoming folder(s)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Depth --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Perform recursive retrieval of up to Depth of the provided incoming folder(s)</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2147483647</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshFolderGroup --> <command:syntaxItem> <maml:name>Get-IshFolder</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>Folders for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshFolder[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Perform recursive retrieval of the provided incoming folder(s)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Depth --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Perform recursive retrieval of up to Depth of the provided incoming folder(s)</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2147483647</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: BaseFolderGroup --> <command:syntaxItem> <maml:name>Get-IshFolder</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: BaseFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BaseFolder</maml:name> <maml:description> <maml:para>The BaseFolder enumeration to get subfolders for the specified root folder</maml:para> <maml:para>Possible values: Data, System, Favorites, EditorTemplate</maml:para> </maml:description> <command:parameterValue required="true">BaseFolder</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+BaseFolder</maml:name> <maml:uri /> <maml:description> <maml:para>Enumerations of basefolders</maml:para> </maml:description> </dev:type> <dev:defaultValue>Data</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> <command:parameterValue required="false" variableLength="false">System</command:parameterValue> <command:parameterValue required="false" variableLength="false">Favorites</command:parameterValue> <command:parameterValue required="false" variableLength="false">EditorTemplate</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Perform recursive retrieval of the provided incoming folder(s)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Depth --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Perform recursive retrieval of up to Depth of the provided incoming folder(s)</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2147483647</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Separated string with the full folder path, e.g. "General\Project\Topics"</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>Unique folder identifier</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: BaseFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BaseFolder</maml:name> <maml:description> <maml:para>The BaseFolder enumeration to get subfolders for the specified root folder</maml:para> <maml:para>Possible values: Data, System, Favorites, EditorTemplate</maml:para> </maml:description> <command:parameterValue required="true">BaseFolder</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+BaseFolder</maml:name> <maml:uri /> <maml:description> <maml:para>Enumerations of basefolders</maml:para> </maml:description> </dev:type> <dev:defaultValue>Data</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> <command:parameterValue required="false" variableLength="false">System</command:parameterValue> <command:parameterValue required="false" variableLength="false">Favorites</command:parameterValue> <command:parameterValue required="false" variableLength="false">EditorTemplate</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>Folders for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshFolder[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Perform recursive retrieval of the provided incoming folder(s)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Depth --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Perform recursive retrieval of up to Depth of the provided incoming folder(s)</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2147483647</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Unique folder identifier</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Folders for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshFolder --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the Folder API holding folder reference like "ishfolderref", "ishfoldertype", "ishfields"</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $requestedMetadata = Set-IshMetadataFilterField -IshSession $ishSession -Name "FNAME" -Level "None" $folderId = 7598 # provide a real folder identifier [Trisoft.ISHRemote.Objects.IshFolders]$ishFoldersRetrieve = Get-IshFolder -IshSession $ishSession ` -FolderIds @($folderId) ` -RequestedMetaData $requestedMetadata [Trisoft.ISHRemote.Objects.IshFields]$ishFields = $ishFoldersRetrieve.Folders[0].IshFields $retrievedFolderName = $ishFields.GetFieldValue("FNAME", "None", "Value")</dev:code> <dev:remarks> <maml:para>Get folder name using Id</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Move-IshFolder --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Move-IshFolder</command:name> <command:verb>Move</command:verb> <command:noun>IshFolder</command:noun> <maml:description> <maml:para>The Move-IshFolder cmdlet moves folders that are passed through the pipeline or determined via provided parameters to a different folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Move-IshFolder cmdlet moves folders that are passed through the pipeline or determined via provided parameters to a different folder.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Move-IshFolder</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>The folder identifier where the folder is currently located</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ToFolderId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ToFolderId</maml:name> <maml:description> <maml:para>The folder identifier where to move the folder to</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshFoldersGroup --> <command:syntaxItem> <maml:name>Move-IshFolder</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ToFolderId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ToFolderId</maml:name> <maml:description> <maml:para>The folder identifier where to move the folder to</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: IshFolders --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshFolders</maml:name> <maml:description> <maml:para>Array with the folders to move. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshFolder[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>The folder identifier where the folder is currently located</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ToFolderId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ToFolderId</maml:name> <maml:description> <maml:para>The folder identifier where to move the folder to</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: IshFolders --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshFolders</maml:name> <maml:description> <maml:para>Array with the folders to move. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshFolder[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the folders to move. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshFolder --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the Folder API holding folder reference like "ishfolderref", "ishfoldertype", "ishfields"</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Remove-IshFolder --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-IshFolder</command:name> <command:verb>Remove</command:verb> <command:noun>IshFolder</command:noun> <maml:description> <maml:para>The Remove-IshFolder cmdlet removes the repository folders that are passed through the pipeline or determined via provided parameters Query and Reference folders are not supported.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-IshFolder cmdlet removes the repository folders that are passed through the pipeline or determined via provided parameters Query and Reference folders are not supported.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: FolderIdGroup --> <command:syntaxItem> <maml:name>Remove-IshFolder</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>Identifier of the folder to be removed</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Perform recursive retrieval of the provided incoming folder(s)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: FolderPathGroup --> <command:syntaxItem> <maml:name>Remove-IshFolder</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Full path to the folder that needs to be removed. Use the IshSession.FolderPathSeparator.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Perform recursive retrieval of the provided incoming folder(s)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshFoldersGroup --> <command:syntaxItem> <maml:name>Remove-IshFolder</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>Array with the folders to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshFolder[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Perform recursive retrieval of the provided incoming folder(s)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Full path to the folder that needs to be removed. Use the IshSession.FolderPathSeparator.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>Identifier of the folder to be removed</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>Array with the folders to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshFolder[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Recurse --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Perform recursive retrieval of the provided incoming folder(s)</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the folders to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" Remove-IshFolder -IshSession $ishSession -FolderId "674580"</dev:code> <dev:remarks> <maml:para>Remove folder with specified Id</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-IshFolder --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-IshFolder</command:name> <command:verb>Set</command:verb> <command:noun>IshFolder</command:noun> <maml:description> <maml:para>The Set-IshFolder cmdlet updates the folders that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-IshFolder cmdlet updates the folders that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Set-IshFolder</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>Identifier of the folder to update</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: NewFolderName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewFolderName</maml:name> <maml:description> <maml:para>New name of the folder</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ReadAccess --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReadAccess</maml:name> <maml:description> <maml:para>String array with the user groups that have read access to this folder. When the string array is empty, all users have read access to the folder</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FolderPathGroup --> <command:syntaxItem> <maml:name>Set-IshFolder</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Separated string with the full folder path</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NewFolderName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewFolderName</maml:name> <maml:description> <maml:para>New name of the folder</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ReadAccess --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReadAccess</maml:name> <maml:description> <maml:para>String array with the user groups that have read access to this folder. When the string array is empty, all users have read access to the folder</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: BaseFolderGroup --> <command:syntaxItem> <maml:name>Set-IshFolder</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: BaseFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BaseFolder</maml:name> <maml:description> <maml:para>The eBaseFolder enumeration to get subfolder(s) for the specified root folder</maml:para> <maml:para>Possible values: Data, System, Favorites, EditorTemplate</maml:para> </maml:description> <command:parameterValue required="true">BaseFolder</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+BaseFolder</maml:name> <maml:uri /> <maml:description> <maml:para>Enumerations of basefolders</maml:para> </maml:description> </dev:type> <dev:defaultValue>Data</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> <command:parameterValue required="false" variableLength="false">System</command:parameterValue> <command:parameterValue required="false" variableLength="false">Favorites</command:parameterValue> <command:parameterValue required="false" variableLength="false">EditorTemplate</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: NewFolderName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewFolderName</maml:name> <maml:description> <maml:para>New name of the folder</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ReadAccess --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReadAccess</maml:name> <maml:description> <maml:para>String array with the user groups that have read access to this folder. When the string array is empty, all users have read access to the folder</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshFolderGroup --> <command:syntaxItem> <maml:name>Set-IshFolder</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>Folder for which to update the metadata. This folder can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshFolder[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Separated string with the full folder path</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BaseFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BaseFolder</maml:name> <maml:description> <maml:para>The eBaseFolder enumeration to get subfolder(s) for the specified root folder</maml:para> <maml:para>Possible values: Data, System, Favorites, EditorTemplate</maml:para> </maml:description> <command:parameterValue required="true">BaseFolder</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+BaseFolder</maml:name> <maml:uri /> <maml:description> <maml:para>Enumerations of basefolders</maml:para> </maml:description> </dev:type> <dev:defaultValue>Data</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> <command:parameterValue required="false" variableLength="false">System</command:parameterValue> <command:parameterValue required="false" variableLength="false">Favorites</command:parameterValue> <command:parameterValue required="false" variableLength="false">EditorTemplate</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: FolderId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>Identifier of the folder to update</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: NewFolderName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewFolderName</maml:name> <maml:description> <maml:para>New name of the folder</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <!-- Parameter: ReadAccess --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReadAccess</maml:name> <maml:description> <maml:para>String array with the user groups that have read access to this folder. When the string array is empty, all users have read access to the folder</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>Folder for which to update the metadata. This folder can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshFolder[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Identifier of the folder to update</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Folder for which to update the metadata. This folder can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshFolder --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the Folder API holding folder reference like "ishfolderref", "ishfoldertype", "ishfields"</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $folderId = 655993 # provide real folder Id $newFolderName = "Updated Folder Name" $updatedFolder = Set-IshFolder -IshSession $ishSession ` -FolderId $folderId ` -NewFolderName $newFolderName</dev:code> <dev:remarks> <maml:para>Update name of a folder with provided FolderId</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-IshFolderContent --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-IshFolderContent</command:name> <command:verb>Get</command:verb> <command:noun>IshFolderContent</command:noun> <maml:description> <maml:para>The Get-IshFolderContent cmdlet returns all document objects or publication outputs stored inside a given folder. You can provide filters to reduce the amount of objects returned, but if you don't provide any: * The cmdlet will return an object for all the latest versions in all language and resolution for a document object folder * The cmdlet will return an object for all the latest versions for all output formats and all language combinations for a publication folder</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-IshFolderContent cmdlet returns all document objects or publication outputs stored inside a given folder. You can provide filters to reduce the amount of objects returned, but if you don't provide any: * The cmdlet will return an object for all the latest versions in all language and resolution for a document object folder * The cmdlet will return an object for all the latest versions for all output formats and all language combinations for a publication folder</maml:para> </maml:description> <command:syntax> <!-- Parameter set: FolderIdGroup --> <command:syntaxItem> <maml:name>Get-IshFolderContent</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>Identifier of the folder for which to retrieve the content</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: VersionFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VersionFilter</maml:name> <maml:description> <maml:para>The version filter to limit the amount of objects returned. When no filter is supplied, latest version objects will be returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>latest</dev:defaultValue> </command:parameter> <!-- Parameter: LanguagesFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LanguagesFilter</maml:name> <maml:description> <maml:para>The langauges filter to limit the amount of objects returned. When no languages filter is supplied, all object languages will be returned.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: FolderPathGroup --> <command:syntaxItem> <maml:name>Get-IshFolderContent</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Separated string with the full folder path</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: VersionFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VersionFilter</maml:name> <maml:description> <maml:para>The version filter to limit the amount of objects returned. When no filter is supplied, latest version objects will be returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>latest</dev:defaultValue> </command:parameter> <!-- Parameter: LanguagesFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LanguagesFilter</maml:name> <maml:description> <maml:para>The langauges filter to limit the amount of objects returned. When no languages filter is supplied, all object languages will be returned.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: BaseFolderGroup --> <command:syntaxItem> <maml:name>Get-IshFolderContent</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: BaseFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BaseFolder</maml:name> <maml:description> <maml:para>The eBaseFolder enumeration to get subfolder(s) for the specified root folder</maml:para> <maml:para>Possible values: Data, System, Favorites, EditorTemplate</maml:para> </maml:description> <command:parameterValue required="true">BaseFolder</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+BaseFolder</maml:name> <maml:uri /> <maml:description> <maml:para>Enumerations of basefolders</maml:para> </maml:description> </dev:type> <dev:defaultValue>Data</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> <command:parameterValue required="false" variableLength="false">System</command:parameterValue> <command:parameterValue required="false" variableLength="false">Favorites</command:parameterValue> <command:parameterValue required="false" variableLength="false">EditorTemplate</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: VersionFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VersionFilter</maml:name> <maml:description> <maml:para>The version filter to limit the amount of objects returned. When no filter is supplied, latest version objects will be returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>latest</dev:defaultValue> </command:parameter> <!-- Parameter: LanguagesFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LanguagesFilter</maml:name> <maml:description> <maml:para>The langauges filter to limit the amount of objects returned. When no languages filter is supplied, all object languages will be returned.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshFolderGroup --> <command:syntaxItem> <maml:name>Get-IshFolderContent</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: VersionFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VersionFilter</maml:name> <maml:description> <maml:para>The version filter to limit the amount of objects returned. When no filter is supplied, latest version objects will be returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>latest</dev:defaultValue> </command:parameter> <!-- Parameter: LanguagesFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LanguagesFilter</maml:name> <maml:description> <maml:para>The langauges filter to limit the amount of objects returned. When no languages filter is supplied, all object languages will be returned.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>Folder for which to retrieve the content. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshFolder[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Separated string with the full folder path</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>Identifier of the folder for which to retrieve the content</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: BaseFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BaseFolder</maml:name> <maml:description> <maml:para>The eBaseFolder enumeration to get subfolder(s) for the specified root folder</maml:para> <maml:para>Possible values: Data, System, Favorites, EditorTemplate</maml:para> </maml:description> <command:parameterValue required="true">BaseFolder</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+BaseFolder</maml:name> <maml:uri /> <maml:description> <maml:para>Enumerations of basefolders</maml:para> </maml:description> </dev:type> <dev:defaultValue>Data</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> <command:parameterValue required="false" variableLength="false">System</command:parameterValue> <command:parameterValue required="false" variableLength="false">Favorites</command:parameterValue> <command:parameterValue required="false" variableLength="false">EditorTemplate</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: VersionFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VersionFilter</maml:name> <maml:description> <maml:para>The version filter to limit the amount of objects returned. When no filter is supplied, latest version objects will be returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>latest</dev:defaultValue> </command:parameter> <!-- Parameter: LanguagesFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LanguagesFilter</maml:name> <maml:description> <maml:para>The langauges filter to limit the amount of objects returned. When no languages filter is supplied, all object languages will be returned.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>System.String[]</dev:defaultValue> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>Folder for which to retrieve the content. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshFolder[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Folder for which to retrieve the content. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $folderId = 7775 #use correct folder id $ishObjects = Get-IshFolderContent -IshSession $ishSession -FolderId $folderId</dev:code> <dev:remarks> <maml:para>Retrieve contents of a given folder</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-IshFolderLocation --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-IshFolderLocation</command:name> <command:verb>Get</command:verb> <command:noun>IshFolderLocation</command:noun> <maml:description> <maml:para>The Get-IshFolderLocation cmdlet returns the repository location of the folder objects in the form of a separated string e.g. "General\Folder1\Folder2"</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-IshFolderLocation cmdlet returns the repository location of the folder objects in the form of a separated string e.g. "General\Folder1\Folder2"</maml:para> </maml:description> <command:syntax> <!-- Parameter set: FolderIdGroup --> <command:syntaxItem> <maml:name>Get-IshFolderLocation</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>Identifier of the folder for which to retrieve the location</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: FolderPathGroup --> <command:syntaxItem> <maml:name>Get-IshFolderLocation</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Separated string with the full folder path</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: BaseFolderGroup --> <command:syntaxItem> <maml:name>Get-IshFolderLocation</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: BaseFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BaseFolder</maml:name> <maml:description> <maml:para>The eBaseFolder enumeration to get subfolder(s) for the specified root folder</maml:para> <maml:para>Possible values: Data, System, Favorites, EditorTemplate</maml:para> </maml:description> <command:parameterValue required="true">BaseFolder</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+BaseFolder</maml:name> <maml:uri /> <maml:description> <maml:para>Enumerations of basefolders</maml:para> </maml:description> </dev:type> <dev:defaultValue>Data</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> <command:parameterValue required="false" variableLength="false">System</command:parameterValue> <command:parameterValue required="false" variableLength="false">Favorites</command:parameterValue> <command:parameterValue required="false" variableLength="false">EditorTemplate</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshFolderGroup --> <command:syntaxItem> <maml:name>Get-IshFolderLocation</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>Folder that is passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshFolder[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Separated string with the full folder path</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>Identifier of the folder for which to retrieve the location</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: BaseFolder --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BaseFolder</maml:name> <maml:description> <maml:para>The eBaseFolder enumeration to get subfolder(s) for the specified root folder</maml:para> <maml:para>Possible values: Data, System, Favorites, EditorTemplate</maml:para> </maml:description> <command:parameterValue required="true">BaseFolder</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+BaseFolder</maml:name> <maml:uri /> <maml:description> <maml:para>Enumerations of basefolders</maml:para> </maml:description> </dev:type> <dev:defaultValue>Data</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> <command:parameterValue required="false" variableLength="false">System</command:parameterValue> <command:parameterValue required="false" variableLength="false">Favorites</command:parameterValue> <command:parameterValue required="false" variableLength="false">EditorTemplate</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>Folder that is passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshFolder[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Identifier of the folder for which to retrieve the location</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Folder that is passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $folderId = 7775 #provide valid folder identifier $folderPath = Get-IshFolderLocation -IshSession $ishSession ` -FolderId $folderId</dev:code> <dev:remarks> <maml:para>Retrieve folder location using provided Id</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-IshLovValue --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-IshLovValue</command:name> <command:verb>Add</command:verb> <command:noun>IshLovValue</command:noun> <maml:description> <maml:para>The Add-IshLovValue cmdlet adds the new values that are passed through the pipeline or determined via provided parameters to the specified List of Values</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-IshLovValue cmdlet adds the new values that are passed through the pipeline or determined via provided parameters to the specified List of Values</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Add-IshLovValue</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LovId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LovId</maml:name> <maml:description> <maml:para>The identifier (element name) of the list of values where the new lov value will be created</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The label of the new lov value</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the new lov value</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LovValueId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LovValueId</maml:name> <maml:description> <maml:para>The identifier (element name) of the new lov value</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshLovValueGroup --> <command:syntaxItem> <maml:name>Add-IshLovValue</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshLovValue --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshLovValue</maml:name> <maml:description> <maml:para>The lov value to create. This lov value can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshLovValue</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshLovValue</maml:name> <maml:uri /> <maml:description> <maml:para>Stores reference for "ishlovvalueref", "ishref", "label", "description", "active"</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LovId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LovId</maml:name> <maml:description> <maml:para>The identifier (element name) of the list of values where the new lov value will be created</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The label of the new lov value</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the new lov value</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshLovValue --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshLovValue</maml:name> <maml:description> <maml:para>The lov value to create. This lov value can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshLovValue</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshLovValue</maml:name> <maml:uri /> <maml:description> <maml:para>Stores reference for "ishlovvalueref", "ishref", "label", "description", "active"</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LovValueId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LovValueId</maml:name> <maml:description> <maml:para>The identifier (element name) of the new lov value</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshLovValue</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The lov value to create. This lov value can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshLovValue --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshLovValue</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Stores reference for "ishlovvalueref", "ishref", "label", "description", "active"</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $lovValue = Add-IshLovValue -IshSession $ishSession -LovId "DILLUSTRATIONTYPE" -Label "New image type" -Description "New image type description"</dev:code> <dev:remarks> <maml:para>Adding a Value into the List of Values</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-IshLovValue --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-IshLovValue</command:name> <command:verb>Get</command:verb> <command:noun>IshLovValue</command:noun> <maml:description> <maml:para>The Get-IshLovValue cmdlet retrieves all values of the specified list of values</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-IshLovValue cmdlet retrieves all values of the specified list of values</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-IshLovValue</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LovId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LovId</maml:name> <maml:description> <maml:para>The element name of the List of Values for which to retrieve values.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LovId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LovId</maml:name> <maml:description> <maml:para>The element name of the List of Values for which to retrieve values.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: IshLovValue --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshLovValue</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Stores reference for "ishlovvalueref", "ishref", "label", "description", "active"</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $lovValues = Get-IshLovValue -IshSession $ishSession -LovId 'DILLUSTRATIONTYPE'</dev:code> <dev:remarks> <maml:para>Retrieve all values from List of Values</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-IshLovValue --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-IshLovValue</command:name> <command:verb>Remove</command:verb> <command:noun>IshLovValue</command:noun> <maml:description> <maml:para>The Remove-IshLovValue cmd-let removes the values that are passed through the pipeline or determined via provided parameters from the specified List of Values</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-IshLovValue cmd-let removes the values that are passed through the pipeline or determined via provided parameters from the specified List of Values</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Remove-IshLovValue</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LovId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LovId</maml:name> <maml:description> <maml:para>The element name of the List of Values to delete Value from</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LovValueId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LovValueId</maml:name> <maml:description> <maml:para>The element name of the value to remove</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshLovValueGroup --> <command:syntaxItem> <maml:name>Remove-IshLovValue</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshLovValue --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshLovValue</maml:name> <maml:description> <maml:para>LovValue object to remove</maml:para> </maml:description> <command:parameterValue required="true">IshLovValue</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshLovValue</maml:name> <maml:uri /> <maml:description> <maml:para>Stores reference for "ishlovvalueref", "ishref", "label", "description", "active"</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LovId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LovId</maml:name> <maml:description> <maml:para>The element name of the List of Values to delete Value from</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LovValueId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LovValueId</maml:name> <maml:description> <maml:para>The element name of the value to remove</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshLovValue --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshLovValue</maml:name> <maml:description> <maml:para>LovValue object to remove</maml:para> </maml:description> <command:parameterValue required="true">IshLovValue</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshLovValue</maml:name> <maml:uri /> <maml:description> <maml:para>Stores reference for "ishlovvalueref", "ishref", "label", "description", "active"</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshLovValue</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>LovValue object to remove</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $lovValue = Add-IshLovValue -IshSession $ishSession -LovId "DILLUSTRATIONTYPE" -Label "New image type" -Description "New image type description" Remove-IshLovValue -IshSession $ishSession -LovId $lovId -LovValueId $lovValue.IshRef</dev:code> <dev:remarks> <maml:para>Add and remove a value</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-IshLovValue --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-IshLovValue</command:name> <command:verb>Set</command:verb> <command:noun>IshLovValue</command:noun> <maml:description> <maml:para>The Set-IshLovValue cmdlet updates the value that is passed through the pipeline or determined via provided parameters in the specified List of Values.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-IshLovValue cmdlet updates the value that is passed through the pipeline or determined via provided parameters in the specified List of Values.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Set-IshLovValue</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LovId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LovId</maml:name> <maml:description> <maml:para>The element name of the List of Values</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LovValueId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LovValueId</maml:name> <maml:description> <maml:para>The element name of the value to update</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The Label of the Value</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The Description of the Value</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Active --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Active</maml:name> <maml:description> <maml:para>The Active parameter indicates if the value is still active. Making it mandatory since uninitialized boolean is 'false' which will be used in update.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshLovValueGroup --> <command:syntaxItem> <maml:name>Set-IshLovValue</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshLovValue --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshLovValue</maml:name> <maml:description> <maml:para>Lov value to update. This lov value can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshLovValue</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshLovValue</maml:name> <maml:uri /> <maml:description> <maml:para>Stores reference for "ishlovvalueref", "ishref", "label", "description", "active"</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LovId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LovId</maml:name> <maml:description> <maml:para>The element name of the List of Values</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LovValueId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LovValueId</maml:name> <maml:description> <maml:para>The element name of the value to update</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Label --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Label</maml:name> <maml:description> <maml:para>The Label of the Value</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>The Description of the Value</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Active --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Active</maml:name> <maml:description> <maml:para>The Active parameter indicates if the value is still active. Making it mandatory since uninitialized boolean is 'false' which will be used in update.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IshLovValue --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshLovValue</maml:name> <maml:description> <maml:para>Lov value to update. This lov value can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshLovValue</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshLovValue</maml:name> <maml:uri /> <maml:description> <maml:para>Stores reference for "ishlovvalueref", "ishref", "label", "description", "active"</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshLovValue</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Lov value to update. This lov value can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshLovValue --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshLovValue</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Stores reference for "ishlovvalueref", "ishref", "label", "description", "active"</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $lovValue1 = Add-IshLovValue -IshSession $ishSession -LovId "DILLUSTRATIONTYPE" -Label "New image type" -Description "New image type description" $lovValue2 = Set-IshLovValue -IshSession $ishSession -LovId "DILLUSTRATIONTYPE" -LovValueId $lovValue1.IshRef -Label "Updated new image type" -Active $true -Description "Updated description"</dev:code> <dev:remarks> <maml:para>Add and update Value</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-IshMetadataField --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-IshMetadataField</command:name> <command:verb>Get</command:verb> <command:noun>IshMetadataField</command:noun> <maml:description> <maml:para>The Get-IshMetadataField -IshSession $ishSession cmdlet return the value of a field with a certain name, level and value type.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-IshMetadataField -IshSession $ishSession cmdlet return the value of a field with a certain name, level and value type. Best practice is to supply IshSession for future functionality.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: IshFieldGroup --> <command:syntaxItem> <maml:name>Get-IshMetadataField</maml:name> <!-- Parameter: IshSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The field name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Level --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Level</maml:name> <maml:description> <maml:para>The field level</maml:para> <maml:para>Possible values: None, Logical, Version, Lng, Progress, Detail, Data</maml:para> </maml:description> <command:parameterValue required="true">Level</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+Level</maml:name> <maml:uri /> <maml:description> <maml:para>Which card or table level should the field be present on. The int assignment allows sorting so Logical before Version before Language.</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Logical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Version</command:parameterValue> <command:parameterValue required="false" variableLength="false">Lng</command:parameterValue> <command:parameterValue required="false" variableLength="false">Progress</command:parameterValue> <command:parameterValue required="false" variableLength="false">Detail</command:parameterValue> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ValueType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueType</maml:name> <maml:description> <maml:para>The value type</maml:para> <maml:para>Possible values: Value, Element, Id, All</maml:para> </maml:description> <command:parameterValue required="true">ValueType</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ValueType</maml:name> <maml:uri /> <maml:description> <maml:para>Which data type to retrieve from the database for the specified field</maml:para> </maml:description> </dev:type> <dev:defaultValue>Value</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Value</command:parameterValue> <command:parameterValue required="false" variableLength="false">Element</command:parameterValue> <command:parameterValue required="false" variableLength="false">Id</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IshField --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshField</maml:name> <maml:description> <maml:para>The fields container object, accepts multiple ISHFields objects</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectGroup --> <command:syntaxItem> <maml:name>Get-IshMetadataField</maml:name> <!-- Parameter: IshSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The field name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Level --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Level</maml:name> <maml:description> <maml:para>The field level</maml:para> <maml:para>Possible values: None, Logical, Version, Lng, Progress, Detail, Data</maml:para> </maml:description> <command:parameterValue required="true">Level</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+Level</maml:name> <maml:uri /> <maml:description> <maml:para>Which card or table level should the field be present on. The int assignment allows sorting so Logical before Version before Language.</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Logical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Version</command:parameterValue> <command:parameterValue required="false" variableLength="false">Lng</command:parameterValue> <command:parameterValue required="false" variableLength="false">Progress</command:parameterValue> <command:parameterValue required="false" variableLength="false">Detail</command:parameterValue> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ValueType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueType</maml:name> <maml:description> <maml:para>The value type</maml:para> <maml:para>Possible values: Value, Element, Id, All</maml:para> </maml:description> <command:parameterValue required="true">ValueType</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ValueType</maml:name> <maml:uri /> <maml:description> <maml:para>Which data type to retrieve from the database for the specified field</maml:para> </maml:description> </dev:type> <dev:defaultValue>Value</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Value</command:parameterValue> <command:parameterValue required="false" variableLength="false">Element</command:parameterValue> <command:parameterValue required="false" variableLength="false">Id</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>The objects container object</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshFolderGroup --> <command:syntaxItem> <maml:name>Get-IshMetadataField</maml:name> <!-- Parameter: IshSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The field name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Level --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Level</maml:name> <maml:description> <maml:para>The field level</maml:para> <maml:para>Possible values: None, Logical, Version, Lng, Progress, Detail, Data</maml:para> </maml:description> <command:parameterValue required="true">Level</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+Level</maml:name> <maml:uri /> <maml:description> <maml:para>Which card or table level should the field be present on. The int assignment allows sorting so Logical before Version before Language.</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Logical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Version</command:parameterValue> <command:parameterValue required="false" variableLength="false">Lng</command:parameterValue> <command:parameterValue required="false" variableLength="false">Progress</command:parameterValue> <command:parameterValue required="false" variableLength="false">Detail</command:parameterValue> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ValueType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueType</maml:name> <maml:description> <maml:para>The value type</maml:para> <maml:para>Possible values: Value, Element, Id, All</maml:para> </maml:description> <command:parameterValue required="true">ValueType</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ValueType</maml:name> <maml:uri /> <maml:description> <maml:para>Which data type to retrieve from the database for the specified field</maml:para> </maml:description> </dev:type> <dev:defaultValue>Value</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Value</command:parameterValue> <command:parameterValue required="false" variableLength="false">Element</command:parameterValue> <command:parameterValue required="false" variableLength="false">Id</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>The objects container object, specialized for folder handling</maml:para> </maml:description> <command:parameterValue required="true">IshFolder[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshEventGroup --> <command:syntaxItem> <maml:name>Get-IshMetadataField</maml:name> <!-- Parameter: IshSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The field name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Level --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Level</maml:name> <maml:description> <maml:para>The field level</maml:para> <maml:para>Possible values: None, Logical, Version, Lng, Progress, Detail, Data</maml:para> </maml:description> <command:parameterValue required="true">Level</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+Level</maml:name> <maml:uri /> <maml:description> <maml:para>Which card or table level should the field be present on. The int assignment allows sorting so Logical before Version before Language.</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Logical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Version</command:parameterValue> <command:parameterValue required="false" variableLength="false">Lng</command:parameterValue> <command:parameterValue required="false" variableLength="false">Progress</command:parameterValue> <command:parameterValue required="false" variableLength="false">Detail</command:parameterValue> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ValueType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueType</maml:name> <maml:description> <maml:para>The value type</maml:para> <maml:para>Possible values: Value, Element, Id, All</maml:para> </maml:description> <command:parameterValue required="true">ValueType</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ValueType</maml:name> <maml:uri /> <maml:description> <maml:para>Which data type to retrieve from the database for the specified field</maml:para> </maml:description> </dev:type> <dev:defaultValue>Value</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Value</command:parameterValue> <command:parameterValue required="false" variableLength="false">Element</command:parameterValue> <command:parameterValue required="false" variableLength="false">Id</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IshEvent --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshEvent</maml:name> <maml:description> <maml:para>The objects container object, specialized for event handling</maml:para> </maml:description> <command:parameterValue required="true">IshEvent[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshEvent[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The field name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Level --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Level</maml:name> <maml:description> <maml:para>The field level</maml:para> <maml:para>Possible values: None, Logical, Version, Lng, Progress, Detail, Data</maml:para> </maml:description> <command:parameterValue required="true">Level</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+Level</maml:name> <maml:uri /> <maml:description> <maml:para>Which card or table level should the field be present on. The int assignment allows sorting so Logical before Version before Language.</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Logical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Version</command:parameterValue> <command:parameterValue required="false" variableLength="false">Lng</command:parameterValue> <command:parameterValue required="false" variableLength="false">Progress</command:parameterValue> <command:parameterValue required="false" variableLength="false">Detail</command:parameterValue> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ValueType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueType</maml:name> <maml:description> <maml:para>The value type</maml:para> <maml:para>Possible values: Value, Element, Id, All</maml:para> </maml:description> <command:parameterValue required="true">ValueType</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ValueType</maml:name> <maml:uri /> <maml:description> <maml:para>Which data type to retrieve from the database for the specified field</maml:para> </maml:description> </dev:type> <dev:defaultValue>Value</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Value</command:parameterValue> <command:parameterValue required="false" variableLength="false">Element</command:parameterValue> <command:parameterValue required="false" variableLength="false">Id</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IshField --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshField</maml:name> <maml:description> <maml:para>The fields container object, accepts multiple ISHFields objects</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>The objects container object</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>The objects container object, specialized for folder handling</maml:para> </maml:description> <command:parameterValue required="true">IshFolder[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshEvent --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshEvent</maml:name> <maml:description> <maml:para>The objects container object, specialized for event handling</maml:para> </maml:description> <command:parameterValue required="true">IshEvent[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshEvent[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The fields container object, accepts multiple ISHFields objects</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The objects container object</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The objects container object, specialized for folder handling</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshEvent[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The objects container object, specialized for event handling</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Get-IshUser -IshSession $ishSession | Get-IshMetadataField -IshSession $ishSession -Name "USERNAME"</dev:code> <dev:remarks> <maml:para>Retrieves your username from the return IshUser object. The Get-IshMetadataField defaults to level None and type value.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-IshMetadataField --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-IshMetadataField</command:name> <command:verb>Set</command:verb> <command:noun>IshMetadataField</command:noun> <maml:description> <maml:para>The Set-IshMetadataField -IshSession $ishSession cmdlet creates value fields based on the parameters provided When IshFields object is passed through the pipeline then new value field is added according to the parameters provided.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-IshMetadataField -IshSession $ishSession cmdlet creates value fields based on the parameters provided When IshFields object is passed through the pipeline then new value field is added according to the parameters provided.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: IshFieldGroup --> <command:syntaxItem> <maml:name>Set-IshMetadataField</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The field name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Level --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Level</maml:name> <maml:description> <maml:para>The field level</maml:para> <maml:para>Possible values: None, Logical, Version, Lng, Progress, Detail, Data</maml:para> </maml:description> <command:parameterValue required="true">Level</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+Level</maml:name> <maml:uri /> <maml:description> <maml:para>Which card or table level should the field be present on. The int assignment allows sorting so Logical before Version before Language.</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Logical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Version</command:parameterValue> <command:parameterValue required="false" variableLength="false">Lng</command:parameterValue> <command:parameterValue required="false" variableLength="false">Progress</command:parameterValue> <command:parameterValue required="false" variableLength="false">Detail</command:parameterValue> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>The field value</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueType</maml:name> <maml:description> <maml:para>The value type</maml:para> <maml:para>Possible values: Value, Element, Id, All</maml:para> </maml:description> <command:parameterValue required="true">ValueType</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ValueType</maml:name> <maml:uri /> <maml:description> <maml:para>Which data type to retrieve from the database for the specified field</maml:para> </maml:description> </dev:type> <dev:defaultValue>Value</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Value</command:parameterValue> <command:parameterValue required="false" variableLength="false">Element</command:parameterValue> <command:parameterValue required="false" variableLength="false">Id</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IshField --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshField</maml:name> <maml:description> <maml:para>The fields container object</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectGroup --> <command:syntaxItem> <maml:name>Set-IshMetadataField</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The field name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Level --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Level</maml:name> <maml:description> <maml:para>The field level</maml:para> <maml:para>Possible values: None, Logical, Version, Lng, Progress, Detail, Data</maml:para> </maml:description> <command:parameterValue required="true">Level</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+Level</maml:name> <maml:uri /> <maml:description> <maml:para>Which card or table level should the field be present on. The int assignment allows sorting so Logical before Version before Language.</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Logical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Version</command:parameterValue> <command:parameterValue required="false" variableLength="false">Lng</command:parameterValue> <command:parameterValue required="false" variableLength="false">Progress</command:parameterValue> <command:parameterValue required="false" variableLength="false">Detail</command:parameterValue> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>The field value</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueType</maml:name> <maml:description> <maml:para>The value type</maml:para> <maml:para>Possible values: Value, Element, Id, All</maml:para> </maml:description> <command:parameterValue required="true">ValueType</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ValueType</maml:name> <maml:uri /> <maml:description> <maml:para>Which data type to retrieve from the database for the specified field</maml:para> </maml:description> </dev:type> <dev:defaultValue>Value</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Value</command:parameterValue> <command:parameterValue required="false" variableLength="false">Element</command:parameterValue> <command:parameterValue required="false" variableLength="false">Id</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>The objects container object</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshFolderGroup --> <command:syntaxItem> <maml:name>Set-IshMetadataField</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The field name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Level --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Level</maml:name> <maml:description> <maml:para>The field level</maml:para> <maml:para>Possible values: None, Logical, Version, Lng, Progress, Detail, Data</maml:para> </maml:description> <command:parameterValue required="true">Level</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+Level</maml:name> <maml:uri /> <maml:description> <maml:para>Which card or table level should the field be present on. The int assignment allows sorting so Logical before Version before Language.</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Logical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Version</command:parameterValue> <command:parameterValue required="false" variableLength="false">Lng</command:parameterValue> <command:parameterValue required="false" variableLength="false">Progress</command:parameterValue> <command:parameterValue required="false" variableLength="false">Detail</command:parameterValue> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>The field value</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueType</maml:name> <maml:description> <maml:para>The value type</maml:para> <maml:para>Possible values: Value, Element, Id, All</maml:para> </maml:description> <command:parameterValue required="true">ValueType</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ValueType</maml:name> <maml:uri /> <maml:description> <maml:para>Which data type to retrieve from the database for the specified field</maml:para> </maml:description> </dev:type> <dev:defaultValue>Value</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Value</command:parameterValue> <command:parameterValue required="false" variableLength="false">Element</command:parameterValue> <command:parameterValue required="false" variableLength="false">Id</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>The objects container object, specialized for folder handling</maml:para> </maml:description> <command:parameterValue required="true">IshFolder[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshEventGroup --> <command:syntaxItem> <maml:name>Set-IshMetadataField</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The field name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Level --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Level</maml:name> <maml:description> <maml:para>The field level</maml:para> <maml:para>Possible values: None, Logical, Version, Lng, Progress, Detail, Data</maml:para> </maml:description> <command:parameterValue required="true">Level</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+Level</maml:name> <maml:uri /> <maml:description> <maml:para>Which card or table level should the field be present on. The int assignment allows sorting so Logical before Version before Language.</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Logical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Version</command:parameterValue> <command:parameterValue required="false" variableLength="false">Lng</command:parameterValue> <command:parameterValue required="false" variableLength="false">Progress</command:parameterValue> <command:parameterValue required="false" variableLength="false">Detail</command:parameterValue> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>The field value</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueType</maml:name> <maml:description> <maml:para>The value type</maml:para> <maml:para>Possible values: Value, Element, Id, All</maml:para> </maml:description> <command:parameterValue required="true">ValueType</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ValueType</maml:name> <maml:uri /> <maml:description> <maml:para>Which data type to retrieve from the database for the specified field</maml:para> </maml:description> </dev:type> <dev:defaultValue>Value</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Value</command:parameterValue> <command:parameterValue required="false" variableLength="false">Element</command:parameterValue> <command:parameterValue required="false" variableLength="false">Id</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IshEvent --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshEvent</maml:name> <maml:description> <maml:para>The objects container object, specialized for event handling</maml:para> </maml:description> <command:parameterValue required="true">IshEvent[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshEvent[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The field name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Level --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Level</maml:name> <maml:description> <maml:para>The field level</maml:para> <maml:para>Possible values: None, Logical, Version, Lng, Progress, Detail, Data</maml:para> </maml:description> <command:parameterValue required="true">Level</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+Level</maml:name> <maml:uri /> <maml:description> <maml:para>Which card or table level should the field be present on. The int assignment allows sorting so Logical before Version before Language.</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Logical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Version</command:parameterValue> <command:parameterValue required="false" variableLength="false">Lng</command:parameterValue> <command:parameterValue required="false" variableLength="false">Progress</command:parameterValue> <command:parameterValue required="false" variableLength="false">Detail</command:parameterValue> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>The field value</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueType</maml:name> <maml:description> <maml:para>The value type</maml:para> <maml:para>Possible values: Value, Element, Id, All</maml:para> </maml:description> <command:parameterValue required="true">ValueType</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ValueType</maml:name> <maml:uri /> <maml:description> <maml:para>Which data type to retrieve from the database for the specified field</maml:para> </maml:description> </dev:type> <dev:defaultValue>Value</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Value</command:parameterValue> <command:parameterValue required="false" variableLength="false">Element</command:parameterValue> <command:parameterValue required="false" variableLength="false">Id</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IshField --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshField</maml:name> <maml:description> <maml:para>The fields container object</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>The objects container object</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>The objects container object, specialized for folder handling</maml:para> </maml:description> <command:parameterValue required="true">IshFolder[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshEvent --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshEvent</maml:name> <maml:description> <maml:para>The objects container object, specialized for event handling</maml:para> </maml:description> <command:parameterValue required="true">IshEvent[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshEvent[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The fields container object</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The objects container object</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The objects container object, specialized for folder handling</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshEvent[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The objects container object, specialized for event handling</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshEvent --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshEvent</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The IshEvent is one entry on the EventMonitor detail are, also holding progress top-level information.</maml:para> </maml:description> </command:returnValue> <!-- OutputType: IshField --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Holds one field metadata entry described by a name, optional level and value</maml:para> </maml:description> </command:returnValue> <!-- OutputType: IshFolder --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the Folder API holding folder reference like "ishfolderref", "ishfoldertype", "ishfields"</maml:para> </maml:description> </command:returnValue> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Set-IshMetadataField -IshSession $ishSession -Name "USERNAME"</dev:code> <dev:remarks> <maml:para>Creates an IshFields structure holding one IshMetadataField with name USERNAME and defaults to level None.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-IshMetadataFilterField --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-IshMetadataFilterField</command:name> <command:verb>Set</command:verb> <command:noun>IshMetadataFilterField</command:noun> <maml:description> <maml:para>The Set-IshMetadataFilterField cmdlet creates filter fields based on the parameters provided When IshFields object is passed through the pipeline then new filter field is added according to the parameters provided.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-IshMetadataFilterField cmdlet creates filter fields based on the parameters provided When IshFields object is passed through the pipeline then new filter field is added according to the parameters provided.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-IshMetadataFilterField</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The field name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Level --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Level</maml:name> <maml:description> <maml:para>The field level</maml:para> <maml:para>Possible values: None, Logical, Version, Lng, Progress, Detail, Data</maml:para> </maml:description> <command:parameterValue required="true">Level</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+Level</maml:name> <maml:uri /> <maml:description> <maml:para>Which card or table level should the field be present on. The int assignment allows sorting so Logical before Version before Language.</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Logical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Version</command:parameterValue> <command:parameterValue required="false" variableLength="false">Lng</command:parameterValue> <command:parameterValue required="false" variableLength="false">Progress</command:parameterValue> <command:parameterValue required="false" variableLength="false">Detail</command:parameterValue> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: FilterOperator --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterOperator</maml:name> <maml:description> <maml:para>The filter operator to use</maml:para> <maml:para>Possible values: Equal, NotEqual, In, NotIn, Like, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, Between, Empty, NotEmpty</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+FilterOperator</maml:name> <maml:uri /> <maml:description> <maml:para>When filtering information having certain value(s), you need operators per field</maml:para> </maml:description> </dev:type> <dev:defaultValue>Equal</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Equal</command:parameterValue> <command:parameterValue required="false" variableLength="false">NotEqual</command:parameterValue> <command:parameterValue required="false" variableLength="false">In</command:parameterValue> <command:parameterValue required="false" variableLength="false">NotIn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Like</command:parameterValue> <command:parameterValue required="false" variableLength="false">GreaterThan</command:parameterValue> <command:parameterValue required="false" variableLength="false">LessThan</command:parameterValue> <command:parameterValue required="false" variableLength="false">GreaterThanOrEqual</command:parameterValue> <command:parameterValue required="false" variableLength="false">LessThanOrEqual</command:parameterValue> <command:parameterValue required="false" variableLength="false">Between</command:parameterValue> <command:parameterValue required="false" variableLength="false">Empty</command:parameterValue> <command:parameterValue required="false" variableLength="false">NotEmpty</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>The value to use for filtering</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueType</maml:name> <maml:description> <maml:para>The value type</maml:para> <maml:para>Possible values: Value, Element, Id, All</maml:para> </maml:description> <command:parameterValue required="true">ValueType</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ValueType</maml:name> <maml:uri /> <maml:description> <maml:para>Which data type to retrieve from the database for the specified field</maml:para> </maml:description> </dev:type> <dev:defaultValue>Value</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Value</command:parameterValue> <command:parameterValue required="false" variableLength="false">Element</command:parameterValue> <command:parameterValue required="false" variableLength="false">Id</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IshField --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshField</maml:name> <maml:description> <maml:para>The fields container object</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The field name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Level --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Level</maml:name> <maml:description> <maml:para>The field level</maml:para> <maml:para>Possible values: None, Logical, Version, Lng, Progress, Detail, Data</maml:para> </maml:description> <command:parameterValue required="true">Level</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+Level</maml:name> <maml:uri /> <maml:description> <maml:para>Which card or table level should the field be present on. The int assignment allows sorting so Logical before Version before Language.</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Logical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Version</command:parameterValue> <command:parameterValue required="false" variableLength="false">Lng</command:parameterValue> <command:parameterValue required="false" variableLength="false">Progress</command:parameterValue> <command:parameterValue required="false" variableLength="false">Detail</command:parameterValue> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: FilterOperator --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterOperator</maml:name> <maml:description> <maml:para>The filter operator to use</maml:para> <maml:para>Possible values: Equal, NotEqual, In, NotIn, Like, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, Between, Empty, NotEmpty</maml:para> </maml:description> <command:parameterValue required="true">FilterOperator</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+FilterOperator</maml:name> <maml:uri /> <maml:description> <maml:para>When filtering information having certain value(s), you need operators per field</maml:para> </maml:description> </dev:type> <dev:defaultValue>Equal</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Equal</command:parameterValue> <command:parameterValue required="false" variableLength="false">NotEqual</command:parameterValue> <command:parameterValue required="false" variableLength="false">In</command:parameterValue> <command:parameterValue required="false" variableLength="false">NotIn</command:parameterValue> <command:parameterValue required="false" variableLength="false">Like</command:parameterValue> <command:parameterValue required="false" variableLength="false">GreaterThan</command:parameterValue> <command:parameterValue required="false" variableLength="false">LessThan</command:parameterValue> <command:parameterValue required="false" variableLength="false">GreaterThanOrEqual</command:parameterValue> <command:parameterValue required="false" variableLength="false">LessThanOrEqual</command:parameterValue> <command:parameterValue required="false" variableLength="false">Between</command:parameterValue> <command:parameterValue required="false" variableLength="false">Empty</command:parameterValue> <command:parameterValue required="false" variableLength="false">NotEmpty</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>The value to use for filtering</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ValueType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueType</maml:name> <maml:description> <maml:para>The value type</maml:para> <maml:para>Possible values: Value, Element, Id, All</maml:para> </maml:description> <command:parameterValue required="true">ValueType</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ValueType</maml:name> <maml:uri /> <maml:description> <maml:para>Which data type to retrieve from the database for the specified field</maml:para> </maml:description> </dev:type> <dev:defaultValue>Value</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Value</command:parameterValue> <command:parameterValue required="false" variableLength="false">Element</command:parameterValue> <command:parameterValue required="false" variableLength="false">Id</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IshField --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshField</maml:name> <maml:description> <maml:para>The fields container object</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The fields container object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshField --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Holds one field metadata entry described by a name, optional level and value</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Set-IshMetadataFilterField -IshSession $ishSession -Name "USERNAME"</dev:code> <dev:remarks> <maml:para>Creates an IshFields structure holding one IshMetadataFilterField with name USERNAME and defaults to level None, FilterOperator Equal and type Value.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-IshOutputFormat --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-IshOutputFormat</command:name> <command:verb>Add</command:verb> <command:noun>IshOutputFormat</command:noun> <maml:description> <maml:para>The Add-IshOutputFormat cmdlet adds the new output formats that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-IshOutputFormat cmdlet adds the new output formats that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Add-IshOutputFormat</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name for the new OutputFormat</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Edt --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Edt</maml:name> <maml:description> <maml:para>EDT for the new OutputFormat</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>MetaData - xml structure that will be used for the new OutputFormat</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Add-IshOutputFormat</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>IshObject - contains OutputFormat data that needs to be created. Pipeline</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name for the new OutputFormat</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Edt --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Edt</maml:name> <maml:description> <maml:para>EDT for the new OutputFormat</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>MetaData - xml structure that will be used for the new OutputFormat</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>IshObject - contains OutputFormat data that needs to be created. Pipeline</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>IshObject - contains OutputFormat data that needs to be created. Pipeline</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metadata = Set-IshMetadataField -IshSession $ishSession -Name "FISHRESOLUTIONS" -Level "none" -Value "Low" | Set-IshMetadataField -IshSession $ishSession -Name "FISHSINGLEFILE" -Level "none" -Value "TRUE" -ValueType Element | Set-IshMetadataField -IshSession $ishSession -Name "FISHCLEANUP" -Level "none" -Value "TRUE" -ValueType Element | Set-IshMetadataField -IshSession $ishSession -Name "FISHKEEPDTDSYSTEMID" -Level "none" -Value "TRUE" -ValueType Element | Set-IshMetadataField -IshSession $ishSession -Name "FISHPUBRESOLVEVARIABLES" -Level "none" -Value "TRUE" -ValueType Element $outputFormat = Add-IshOutputFormat -IshSession $ishSession ` -Name "MyOutputFormat" ` -EDT "EDTPDF" ` -Metadata $metadata</dev:code> <dev:remarks> <maml:para>Adding a new output format</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Find-IshOutputFormat --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Find-IshOutputFormat</command:name> <command:verb>Find</command:verb> <command:noun>IshOutputFormat</command:noun> <maml:description> <maml:para>The Find-IshOutputFormat cmdlet finds output format objects using ActivityFilter and MetadataFilter that are provided</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Find-IshOutputFormat cmdlet finds output format objects using ActivityFilter and MetadataFilter that are provided</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Find-IshOutputFormat</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $ishMetadataFilterFields = Set-IshMetadataFilterField -IshSession $ishSession -Name "FISHOUTPUTFORMATNAME" -Level "None" -FilterOperator "Like" -Value "%PDF%" $outputFormats = Find-IshOutputFormat -IshSession $ishSession ` -MetadataFilter $ishMetadataFilterFields</dev:code> <dev:remarks> <maml:para>Find output formats with specific names</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-IshOutputFormat --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-IshOutputFormat</command:name> <command:verb>Get</command:verb> <command:noun>IshOutputFormat</command:noun> <maml:description> <maml:para>The Get-IshOutputFormat cmdlet retrieves the metadata of the output formats that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-IshOutputFormat cmdlet retrieves the metadata of the output formats that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Get-IshOutputFormat</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Array with the element names of the output formats</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Get-IshOutputFormat</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Output formats for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Array with the element names of the output formats</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Output formats for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Output formats for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $requestedMetadata = Set-IshRequestedMetadataField -IshSession $ishSession -Name "FISHOUTPUTFORMATNAME" -Level "none" $name = Get-IshOutputFormat -IshSession $ishSession -Id "GUID-2A69335D-F025-4963-A142-5E49988C7C0C" -RequestedMetadata $requestedMetadata | Get-IshMetadataField -IshSession $ishSession -Name "FISHOUTPUTFORMATNAME" -Level None -ValueType Value</dev:code> <dev:remarks> <maml:para>Retrieve name of the existing output format</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-IshOutputFormat --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-IshOutputFormat</command:name> <command:verb>Remove</command:verb> <command:noun>IshOutputFormat</command:noun> <maml:description> <maml:para>The Remove-IshOutputFormat cmdlet removes the output formats that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-IshOutputFormat cmdlet removes the output formats that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Remove-IshOutputFormat</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id - element name of the OutputFormat to be removed</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Remove-IshOutputFormat</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>The IshObject array containing OutputFormats that needs to be deleted. Pipeline</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id - element name of the OutputFormat to be removed</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>The IshObject array containing OutputFormats that needs to be deleted. Pipeline</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The IshObject array containing OutputFormats that needs to be deleted. Pipeline</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metadata = Set-IshMetadataField -IshSession $ishSession -Name "FISHRESOLUTIONS" -Level "none" -Value "Low" | Set-IshMetadataField -IshSession $ishSession -Name "FISHSINGLEFILE" -Level "none" -Value "TRUE" -ValueType Element | Set-IshMetadataField -IshSession $ishSession -Name "FISHCLEANUP" -Level "none" -Value "TRUE" -ValueType Element | Set-IshMetadataField -IshSession $ishSession -Name "FISHKEEPDTDSYSTEMID" -Level "none" -Value "TRUE" -ValueType Element | Set-IshMetadataField -IshSession $ishSession -Name "FISHPUBRESOLVEVARIABLES" -Level "none" -Value "TRUE" -ValueType Element $outputFormatAdd = Add-IshOutputFormat -IshSession $ishSession ` -Name "MyOutputFormat" ` -EDT "EDTPDF" ` -Metadata $metadata Remove-IshOutputFormat -IshSession $ishSession -Id $outputFormatAdd[0].IshRef</dev:code> <dev:remarks> <maml:para>Remove added output format</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-IshOutputFormat --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-IshOutputFormat</command:name> <command:verb>Set</command:verb> <command:noun>IshOutputFormat</command:noun> <maml:description> <maml:para>The Set-IshOutputFormat cmdlet updates the output formats that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-IshOutputFormat cmdlet updates the output formats that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Set-IshOutputFormat</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The element name of the output format</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Edt --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Edt</maml:name> <maml:description> <maml:para>The unique identifier of the Electronic Document Type of the output (e.g. EDTPDF, EDTXML, EDTHTML,...)</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata to set for the output format</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Set-IshOutputFormat</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Output formats for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The element name of the output format</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Edt --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Edt</maml:name> <maml:description> <maml:para>The unique identifier of the Electronic Document Type of the output (e.g. EDTPDF, EDTXML, EDTHTML,...)</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata to set for the output format</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Output formats for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Output formats for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metadataUpdate = Set-IshMetadataField -IshSession $ishSession -Name "FISHOUTPUTFORMATNAME" -Level "none" -Value "PDF (A4 Manual) updated" $outputFormatUpdate = Set-IshOutputFormat -IshSession $ishSession ` -Id "GUID-2A69335D-F025-4963-A142-5E49988C7C0C" ` -Edt "EDTPDF" ` -Metadata $metadataUpdate</dev:code> <dev:remarks> <maml:para>Update name of the existing Output format</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-IshPublicationOutput --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-IshPublicationOutput</command:name> <command:verb>Add</command:verb> <command:noun>IshPublicationOutput</command:noun> <maml:description> <maml:para>The Add-IshPublicationOutput cmdlet add the new publication outputs that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-IshPublicationOutput cmdlet add the new publication outputs that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Add-IshPublicationOutput</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>The FolderId for the PublicationOutput object.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>The FolderId of the PublicationOutput by IshFolder object</maml:para> </maml:description> <command:parameterValue required="true">IshFolder</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder</maml:name> <maml:uri /> <maml:description> <maml:para>Generic pipeline object for the Folder API holding folder reference like "ishfolderref", "ishfoldertype", "ishfields"</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The LogicalId of the Publication.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>GUID-75C3C339-A11A-4B21-932F-F05E0A00F166</dev:defaultValue> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Version of the Publication.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>NEW</dev:defaultValue> </command:parameter> <!-- Parameter: OutputFormat --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>The requested OutputFormat for the new PublicationOutput.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LanguageCombination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LanguageCombination</maml:name> <maml:description> <maml:para>The requested language combination for the new PublicationOutput.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata for the new PublicationOutput.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Add-IshPublicationOutput</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>The IshObjects that need to be added.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>The FolderId for the PublicationOutput object.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>The FolderId of the PublicationOutput by IshFolder object</maml:para> </maml:description> <command:parameterValue required="true">IshFolder</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder</maml:name> <maml:uri /> <maml:description> <maml:para>Generic pipeline object for the Folder API holding folder reference like "ishfolderref", "ishfoldertype", "ishfields"</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>The IshObjects that need to be added.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>The FolderId for the PublicationOutput object.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <!-- Parameter: IshFolder --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshFolder</maml:name> <maml:description> <maml:para>The FolderId of the PublicationOutput by IshFolder object</maml:para> </maml:description> <command:parameterValue required="true">IshFolder</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshFolder</maml:name> <maml:uri /> <maml:description> <maml:para>Generic pipeline object for the Folder API holding folder reference like "ishfolderref", "ishfoldertype", "ishfields"</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The LogicalId of the Publication.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>GUID-66CEAC53-9EAE-4062-A58F-8BE5AAFA3F41</dev:defaultValue> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The Version of the Publication.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>NEW</dev:defaultValue> </command:parameter> <!-- Parameter: OutputFormat --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>The requested OutputFormat for the new PublicationOutput.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LanguageCombination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LanguageCombination</maml:name> <maml:description> <maml:para>The requested language combination for the new PublicationOutput.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata for the new PublicationOutput.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The IshObjects that need to be added.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metaDataCreate = Set-IshMetadataField -IshSession $ishSession -Name 'FISHFALLBACKLNGDEFAULT' -Level 'lng' -Value 'en' | Set-IshMetadataField -IshSession $ishSession -Name 'FISHFALLBACKLNGIMAGES' -Level 'lng' -Value 'en' | Set-IshMetadataField -IshSession $ishSession -Name 'FISHFALLBACKLNGRESOURCES' -Level 'lng' -Value 'en' Add-IshPublicationOutput -IshSession $ishSession ` -LogicalId "GUID-7EB6F836-A801-4DB3-A54A-22C207BAF671" ` -Version "1" ` -OutputFormat "GUID-2A69335D-F025-4963-A142-5E49988C7C0C" ` -LanguageCombination "en" ` -Metadata $metaDataCreate</dev:code> <dev:remarks> <maml:para>Creating a new publication output</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Find-IshPublicationOutput --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Find-IshPublicationOutput</command:name> <command:verb>Find</command:verb> <command:noun>IshPublicationOutput</command:noun> <maml:description> <maml:para>The Find-IshPublicationOutput cmdlet finds all publication outputs using the StatusFilter and MetadataFilter that are provided.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Find-IshPublicationOutput cmdlet finds all publication outputs using the StatusFilter and MetadataFilter that are provided.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Find-IshPublicationOutput</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: StatusFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StatusFilter</maml:name> <maml:description> <maml:para>The status filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: ISHReleasedStates, ISHReleasedOrDraftStates, ISHOutOfDateOrReleasedStates, ISHNoStatusFilter</maml:para> </maml:description> <command:parameterValue required="true">StatusFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+StatusFilter</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration matching the API status filters for IshObjects</maml:para> </maml:description> </dev:type> <dev:defaultValue>ISHNoStatusFilter</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ISHReleasedStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHReleasedOrDraftStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHOutOfDateOrReleasedStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHNoStatusFilter</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: StatusFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StatusFilter</maml:name> <maml:description> <maml:para>The status filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: ISHReleasedStates, ISHReleasedOrDraftStates, ISHOutOfDateOrReleasedStates, ISHNoStatusFilter</maml:para> </maml:description> <command:parameterValue required="true">StatusFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+StatusFilter</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration matching the API status filters for IshObjects</maml:para> </maml:description> </dev:type> <dev:defaultValue>ISHNoStatusFilter</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ISHReleasedStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHReleasedOrDraftStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHOutOfDateOrReleasedStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHNoStatusFilter</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $requestedMetadataRetrieve = Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHOUTPUTFORMATREF' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBLNGCOMBINATION' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBSTATUS' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBLISHER' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBSTARTDATE' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBENDDATE' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'VERSION' -Level "Version" $metadataFilterRetrieve = Set-IshMetadataFilterField -IshSession $ishSession -Name 'FISHPUBSTATUS' -Level 'Lng' -ValueType "Value" -FilterOperator "Equal" -Value "To Be Published" $publicationOutputs = Find-IshPublicationOutput -IshSession $ishSession -StatusFilter "ishnostatusfilter" -MetadataFilter $metadataFilterRetrieve -RequestedMetadata $requestedMetadataRetrieve</dev:code> <dev:remarks> <maml:para>Finding publication outputs</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-IshPublicationOutput --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-IshPublicationOutput</command:name> <command:verb>Get</command:verb> <command:noun>IshPublicationOutput</command:noun> <maml:description> <maml:para>The Get-IshPublicationOutput cmdlet retrieves the metadata of the publication outputs that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-IshPublicationOutput cmdlet retrieves the metadata of the publication outputs that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Get-IshPublicationOutput</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The LogicalId of the publication output objects.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StatusFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StatusFilter</maml:name> <maml:description> <maml:para>The status filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: ISHReleasedStates, ISHReleasedOrDraftStates, ISHOutOfDateOrReleasedStates, ISHNoStatusFilter</maml:para> </maml:description> <command:parameterValue required="true">StatusFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+StatusFilter</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration matching the API status filters for IshObjects</maml:para> </maml:description> </dev:type> <dev:defaultValue>ISHNoStatusFilter</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ISHReleasedStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHReleasedOrDraftStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHOutOfDateOrReleasedStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHNoStatusFilter</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Get-IshPublicationOutput</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the publication outputs for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The LogicalId of the publication output objects.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the publication outputs for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StatusFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StatusFilter</maml:name> <maml:description> <maml:para>The status filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: ISHReleasedStates, ISHReleasedOrDraftStates, ISHOutOfDateOrReleasedStates, ISHNoStatusFilter</maml:para> </maml:description> <command:parameterValue required="true">StatusFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+StatusFilter</maml:name> <maml:uri /> <maml:description> <maml:para>Enumeration matching the API status filters for IshObjects</maml:para> </maml:description> </dev:type> <dev:defaultValue>ISHNoStatusFilter</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ISHReleasedStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHReleasedOrDraftStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHOutOfDateOrReleasedStates</command:parameterValue> <command:parameterValue required="false" variableLength="false">ISHNoStatusFilter</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the publication outputs for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $requestedMetadataRetrieve = Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHOUTPUTFORMATREF' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBLNGCOMBINATION' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBSTATUS' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBLISHER' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBSTARTDATE' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBENDDATE' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'VERSION' -Level "Version" $metadataFilterRetrieve = Set-IshMetadataFilterField -IshSession $ishSession -Name 'FISHPUBSTATUS' -Level 'Lng' -ValueType "Value" -FilterOperator "Equal" -Value "Draft" $publicationOutput = Get-IshPublicationOutput -IshSession $ishSession ` -LogicalId @("GUID-412E3A98-9AA8-484E-A1AA-3DE3B58947BD", "GUID-F66C1BB5-076D-455C-B055-DAC5D61AB3D9") ` -StatusFilter "ishreleasedordraftstates" ` -RequestedMetadata $requestedMetadataRetrieve ` -MetadataFilter $metadataFilterRetrieve</dev:code> <dev:remarks> <maml:para>Retrieving publication outputs</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Publish-IshPublicationOutput --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Publish-IshPublicationOutput</command:name> <command:verb>Publish</command:verb> <command:noun>IshPublicationOutput</command:noun> <maml:description> <maml:para>The Publish-IshPublicationOutput cmdlet publishes all publication outputs that are passed through the pipeline or determined via provided parameters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Publish-IshPublicationOutput cmdlet publishes all publication outputs that are passed through the pipeline or determined via provided parameters.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Publish-IshPublicationOutput</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The logical identifier of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFormat --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>The output format (GUID) of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LanguageCombination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LanguageCombination</maml:name> <maml:description> <maml:para>The language combination of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the publication output. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository</maml:para> <maml:para>If the metadata is still the same, the publication output is published.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the publication output is not published.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Publish-IshPublicationOutput</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the publications outputs to publish. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the publication output. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository</maml:para> <maml:para>If the metadata is still the same, the publication output is published.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the publication output is not published.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the publications outputs to publish. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The logical identifier of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFormat --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>The output format (GUID) of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LanguageCombination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LanguageCombination</maml:name> <maml:description> <maml:para>The language combination of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the publication output. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository</maml:para> <maml:para>If the metadata is still the same, the publication output is published.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the publication output is not published.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the publications outputs to publish. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $ishobjects = Publish-IshPublicationOutput -IshSession $ishSession ` -LogicalId "GUID-F66C1BB5-076D-455C-B055-DAC5D61AB3D9" ` -Version "1" ` -OutputFormat "GUID-2A69335D-F025-4963-A142-5E49988C7C0C" ` -LanguageCombination "en"</dev:code> <dev:remarks> <maml:para>Publishing a publication output</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-IshPublicationOutput --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-IshPublicationOutput</command:name> <command:verb>Remove</command:verb> <command:noun>IshPublicationOutput</command:noun> <maml:description> <maml:para>The Remove-IshPublicationOutput cmdlet removes the publication outputs that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-IshPublicationOutput cmdlet removes the publication outputs that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Remove-IshPublicationOutput</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The LogicalId of the publication output</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version of the publication output</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFormat --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>The output format of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LanguageCombination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LanguageCombination</maml:name> <maml:description> <maml:para>The language combination of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the publication output. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</maml:para> <maml:para>If the metadata is still the same, the publication output is removed.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the publication output is not removed.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>When the Force switch is set, after deleting the publication output object, the publication version object and publication logical object will be deleted if they don't have any publication outputs anymore. Be carefull using this option, as it will delete the publication (version) and baseline if there are no outputformats left!!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Remove-IshPublicationOutput</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the publication outputs to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the publication output. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</maml:para> <maml:para>If the metadata is still the same, the publication output is removed.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the publication output is not removed.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>When the Force switch is set, after deleting the publication output object, the publication version object and publication logical object will be deleted if they don't have any publication outputs anymore. Be carefull using this option, as it will delete the publication (version) and baseline if there are no outputformats left!!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the publication outputs to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The LogicalId of the publication output</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version of the publication output</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFormat --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>The output format of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LanguageCombination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LanguageCombination</maml:name> <maml:description> <maml:para>The language combination of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the publication output. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</maml:para> <maml:para>If the metadata is still the same, the publication output is removed.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the publication output is not removed.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>When the Force switch is set, after deleting the publication output object, the publication version object and publication logical object will be deleted if they don't have any publication outputs anymore. Be carefull using this option, as it will delete the publication (version) and baseline if there are no outputformats left!!</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the publication outputs to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" # Remove publication output Remove-IshPublicationOutput -IshSession $ishSession ` -LogicalId "GUID-F66C1BB5-076D-455C-B055-DAC5D61AB3D9" ` -Version "1" ` -OutputFormat "PDF (A4 Manual)" ` -LanguageCombination "en"</dev:code> <dev:remarks> <maml:para>Removing a publication output</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-IshPublicationOutput --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-IshPublicationOutput</command:name> <command:verb>Set</command:verb> <command:noun>IshPublicationOutput</command:noun> <maml:description> <maml:para>The Set-IshPublicationOutput cmdlet updates the publication outputs that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-IshPublicationOutput cmdlet updates the publication outputs that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Set-IshPublicationOutput</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The LogicalId of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFormat --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>The output format of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LanguageCombination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LanguageCombination</maml:name> <maml:description> <maml:para>The language combination of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata to set for the publication output object.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the publication output. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</maml:para> <maml:para>If the metadata is still the same, the metadata will be set.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the metadata will be set.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Set-IshPublicationOutput</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Publication outputs for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the publication output. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</maml:para> <maml:para>If the metadata is still the same, the metadata will be set.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the metadata will be set.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Publication outputs for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The LogicalId of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFormat --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>The output format of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LanguageCombination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LanguageCombination</maml:name> <maml:description> <maml:para>The language combination of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata to set for the publication output object.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the publication output. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</maml:para> <maml:para>If the metadata is still the same, the metadata will be set.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the metadata will be set.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Publication outputs for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" # Update a publication output $metadataUpdate = Set-IshMetadataField -IshSession $ishSession -Name 'FISHFALLBACKLNGDEFAULT' -Level 'lng' -Value 'bg' | Set-IshMetadataField -IshSession $ishSession -Name 'FISHFALLBACKLNGIMAGES' -Level 'lng' -Value 'bg' | Set-IshMetadataField -IshSession $ishSession -Name 'FISHFALLBACKLNGRESOURCES' -Level 'lng' -Value 'bg' Set-IshPublicationOutput -IshSession $ishSession ` -LogicalId "GUID-F66C1BB5-076D-455C-B055-DAC5D61AB3D9" ` -Version "1" ` -OutputFormat "GUID-2A69335D-F025-4963-A142-5E49988C7C0C" ` -LanguageCombination "en" ` -MetaData $metadataUpdate</dev:code> <dev:remarks> <maml:para>Updating publication outputs</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Stop-IshPublicationOutput --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Stop-IshPublicationOutput</command:name> <command:verb>Stop</command:verb> <command:noun>IshPublicationOutput</command:noun> <maml:description> <maml:para>The Stop-IshPublicationOutputcmdlet cancels publishes of all publication outputs that are passed through the pipeline or determined via provided parameters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Stop-IshPublicationOutputcmdlet cancels publishes of all publication outputs that are passed through the pipeline or determined via provided parameters.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Stop-IshPublicationOutput</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The logical identifier of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFormat --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>The output format (GUID) of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LanguageCombination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LanguageCombination</maml:name> <maml:description> <maml:para>The language combination of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the publication output. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository. If the metadata is still the same, the publication output is cancelled. If the metadata is not the same anymore, an error is given and the publication output is not cancelled.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Stop-IshPublicationOutput</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the publication outputs to cancel. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the publication output. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository. If the metadata is still the same, the publication output is cancelled. If the metadata is not the same anymore, an error is given and the publication output is not cancelled.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the publication outputs to cancel. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The logical identifier of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputFormat --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputFormat</maml:name> <maml:description> <maml:para>The output format (GUID) of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LanguageCombination --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LanguageCombination</maml:name> <maml:description> <maml:para>The language combination of the publication output.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the publication output. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository. If the metadata is still the same, the publication output is cancelled. If the metadata is not the same anymore, an error is given and the publication output is not cancelled.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the publication outputs to cancel. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $ishobjects = Stop-IshPublicationOutput-IshSession $ishSession ` -LogicalId "GUID-F66C1BB5-076D-455C-B055-DAC5D61AB3D9" ` -Version "1" ` -OutputFormat "GUID-2A69335D-F025-4963-A142-5E49988C7C0C" ` -LanguageCombination "en"</dev:code> <dev:remarks> <maml:para>Cancelling publish of a publication output</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>function Add-Properties { param ($ishObject) [xml]$metadataXml = $ishObject.IshFields.ToXml() foreach($field in $metadataXml.SelectNodes("/ishfields/ishfield")) { $ishObject = $ishObject | Add-Member -MemberType NoteProperty -Name $field.GetAttribute("name") -Value ($field.InnerText) -PassThru -Force } Write-Output $ishObject } $requestedMetadata = Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBLNGCOMBINATION' -Level Lng | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBSTATUS' -Level Lng | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBLISHER' -Level Lng | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBSTARTDATE' -Level Lng | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBENDDATE' -Level Lng | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'VERSION' -Level Version | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FTITLE' -Level Logical $metadataFilter = Set-IshMetadataFilterField -IshSession $ishSession -Name 'FISHPUBSTATUS' -Level Lng -ValueType Element -FilterOperator In -Value "VPUBSTATUSPUBLISHINGCANCELLED, VPUBSTATUSPUBLISHPENDING, VPUBSTATUSPUBLISHING" # VPUBSTATUSTOBEPUBLISHED $ishObjects = Find-IshPublicationOutput -IshSession $ishSession -MetadataFilter $metadataFilter -RequestedMetadata $requestedMetadata $ishObjectsToCancel = $ishObjects | ForEach-Object { Add-Properties $_ } | Select-Object -Property FTITLE,IshRef,VERSION,FISHPUBLNGCOMBINATION,FISHOUTPUTFORMATREF,FISHPUBLISHER,FISHPUBSTATUS,FISHPUBSTARTDATE,FISHPUBENDDATE | Out-GridView -OutputMode Multiple -Title "Select one or more entries to Cancel publishing on"</dev:code> <dev:remarks> <maml:para>Finding all publications that are currently in progress. For now auxiliary function Add-Properties promotes ishfields in a simple way to become NoteProperties on the root ishobject.</maml:para> <maml:para>Passing them in PowerShell ISE to Out-GridView for pipeline handling downstream.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-IshPublicationOutputData --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-IshPublicationOutputData</command:name> <command:verb>Get</command:verb> <command:noun>IshPublicationOutputData</command:noun> <maml:description> <maml:para>The Get-IshPublicationOutputData cmdlet retrieves the data/blob of the publication output that are passed through the pipeline or determined via provided parameters and saves them to the given Windows folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-IshPublicationOutputData cmdlet retrieves the data/blob of the publication output that are passed through the pipeline or determined via provided parameters and saves them to the given Windows folder.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-IshPublicationOutputData</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the publication outputs for which to retrieve the data. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder on the Windows filesystem where to store the retrieved data files</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the publication outputs for which to retrieve the data. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folder on the Windows filesystem where to store the retrieved data files</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the publication outputs for which to retrieve the data. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: FileInfo --> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $requestedMetadataRetrieve = Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHOUTPUTFORMATREF' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBLNGCOMBINATION' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBSTATUS' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBLISHER' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBSTARTDATE' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'FISHPUBENDDATE' -Level "Lng" | Set-IshRequestedMetadataField -IshSession $ishSession -Name 'VERSION' -Level "Version" $metadataFilterRetrieve = Set-IshMetadataFilterField -IshSession $ishSession -Name 'FISHPUBSTATUS' -Level 'Lng' -ValueType "Value" -FilterOperator "Equal" -Value "Draft" $publicationOutputs = Find-IshPublicationOutput -IshSession $ishSession -StatusFilter "ishnostatusfilter" -MetadataFilter $metadataFilterRetrieve -RequestedMetadata $requestedMetadataRetrieve $fileInfoArray = $publicationOutputs | Get-IshPublicationOutputData -IshSession $ishSession -FolderPath "c:\temp\export"</dev:code> <dev:remarks> <maml:para>Downloading publication outputs</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-IshPublicationOutputFolderLocation --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-IshPublicationOutputFolderLocation</command:name> <command:verb>Get</command:verb> <command:noun>IshPublicationOutputFolderLocation</command:noun> <maml:description> <maml:para>The Get-IshPublicationOutputFolderLocation cmdlet returns the repository location of the publication output in the form of a separated string e.g. "General\Folder1\Folder2"</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-IshPublicationOutputFolderLocation cmdlet returns the repository location of the publication output in the form of a separated string e.g. "General\Folder1\Folder2"</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Get-IshPublicationOutputFolderLocation</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The LogicalId of the PublicationOutput object</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectGroup --> <command:syntaxItem> <maml:name>Get-IshPublicationOutputFolderLocation</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Publication output for which to retrieve the content data. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LogicalId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LogicalId</maml:name> <maml:description> <maml:para>The LogicalId of the PublicationOutput object</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Publication output for which to retrieve the content data. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Publication output for which to retrieve the content data. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $folderLocation = Get-IshPublicationOutputFolderLocation -IshSession $ishSession -LogicalId "GUID-412E3A98-9AA8-484E-A1AA-3DE3B58947BD"</dev:code> <dev:remarks> <maml:para>Retrieve location of the PublicationOutput</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-IshRequestedMetadataField --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-IshRequestedMetadataField</command:name> <command:verb>Set</command:verb> <command:noun>IshRequestedMetadataField</command:noun> <maml:description> <maml:para>The Set-IshRequestedMetadataField cmdlet creates a field with a certain name, level and value type When IshFields object is passed through the pipeline then the new field is added to that object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-IshRequestedMetadataField cmdlet creates a field with a certain name, level and value type When IshFields object is passed through the pipeline then the new field is added to that object.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-IshRequestedMetadataField</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The field name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Level --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Level</maml:name> <maml:description> <maml:para>The field level</maml:para> <maml:para>Possible values: None, Logical, Version, Lng, Progress, Detail, Data</maml:para> </maml:description> <command:parameterValue required="true">Level</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+Level</maml:name> <maml:uri /> <maml:description> <maml:para>Which card or table level should the field be present on. The int assignment allows sorting so Logical before Version before Language.</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Logical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Version</command:parameterValue> <command:parameterValue required="false" variableLength="false">Lng</command:parameterValue> <command:parameterValue required="false" variableLength="false">Progress</command:parameterValue> <command:parameterValue required="false" variableLength="false">Detail</command:parameterValue> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ValueType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueType</maml:name> <maml:description> <maml:para>The value type</maml:para> <maml:para>Possible values: Value, Element, Id, All</maml:para> </maml:description> <command:parameterValue required="true">ValueType</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ValueType</maml:name> <maml:uri /> <maml:description> <maml:para>Which data type to retrieve from the database for the specified field</maml:para> </maml:description> </dev:type> <dev:defaultValue>Value</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Value</command:parameterValue> <command:parameterValue required="false" variableLength="false">Element</command:parameterValue> <command:parameterValue required="false" variableLength="false">Id</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IshField --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshField</maml:name> <maml:description> <maml:para>The fields container object</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The field name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Level --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Level</maml:name> <maml:description> <maml:para>The field level</maml:para> <maml:para>Possible values: None, Logical, Version, Lng, Progress, Detail, Data</maml:para> </maml:description> <command:parameterValue required="true">Level</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+Level</maml:name> <maml:uri /> <maml:description> <maml:para>Which card or table level should the field be present on. The int assignment allows sorting so Logical before Version before Language.</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Logical</command:parameterValue> <command:parameterValue required="false" variableLength="false">Version</command:parameterValue> <command:parameterValue required="false" variableLength="false">Lng</command:parameterValue> <command:parameterValue required="false" variableLength="false">Progress</command:parameterValue> <command:parameterValue required="false" variableLength="false">Detail</command:parameterValue> <command:parameterValue required="false" variableLength="false">Data</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ValueType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValueType</maml:name> <maml:description> <maml:para>The value type</maml:para> <maml:para>Possible values: Value, Element, Id, All</maml:para> </maml:description> <command:parameterValue required="true">ValueType</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ValueType</maml:name> <maml:uri /> <maml:description> <maml:para>Which data type to retrieve from the database for the specified field</maml:para> </maml:description> </dev:type> <dev:defaultValue>Value</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Value</command:parameterValue> <command:parameterValue required="false" variableLength="false">Element</command:parameterValue> <command:parameterValue required="false" variableLength="false">Id</command:parameterValue> <command:parameterValue required="false" variableLength="false">All</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: IshField --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshField</maml:name> <maml:description> <maml:para>The fields container object</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The fields container object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshField --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Holds one field metadata entry described by a name, optional level and value</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Set-IshRequestedMetadataField -IshSession $ishSession -Name "USERNAME"</dev:code> <dev:remarks> <maml:para>Creates an IshFields structure holding one IshRequestedMetadataField with name USERNAME and defaults to level None.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: New-IshSession --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-IshSession</command:name> <command:verb>New</command:verb> <command:noun>IshSession</command:noun> <maml:description> <maml:para>The New-IshSession cmdlet creates a new IshSession object using the parameters that are provided.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-IshSession cmdlet creates a new IshSession object using the parameters that are provided.</maml:para> <maml:para>The object contains the service endpoint proxies, and api contract information like multi-value seperator, date format, etc</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ActiveDirectoryAuthGroup --> <command:syntaxItem> <maml:name>New-IshSession</maml:name> <!-- Parameter: WsBaseUrl --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WsBaseUrl</maml:name> <maml:description> <maml:para>SDL Knowledge Center Content Manager web services main URL. Note that the URL is case-sensitive and should end with an ending slash! For example: "https://example.com/ISHWS/"</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout value expressed as TimeSpan, that controls Send/Receive timeouts of HttpClient when downloading content like connectionconfiguration.xml Defaults to 20 seconds.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:20</dev:defaultValue> </command:parameter> <!-- Parameter: TimeoutIssue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutIssue</maml:name> <maml:description> <maml:para>Timeout value expressed as TimeSpan, that controls Send/Receive timeouts of WCF when issuing a token. Defaults to maximum timespan.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10675199.02:48:05.4775807</dev:defaultValue> </command:parameter> <!-- Parameter: TimeoutService --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutService</maml:name> <maml:description> <maml:para>Timeout value expressed as TimeSpan, that controls Send/Receive timeouts of WCF for InfoShareWS proxies. Defaults to maximum timespan.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10675199.02:48:05.4775807</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreSslPolicyErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreSslPolicyErrors</maml:name> <maml:description> <maml:para>IgnoreSslPolicyErrors presence indicates that a custom callback will be assigned to ServicePointManager.ServerCertificateValidationCallback. Defaults false of course, as this is creates security holes! But very handy for Fiddler usage though.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: UserNamePasswordAuthGroup --> <command:syntaxItem> <maml:name>New-IshSession</maml:name> <!-- Parameter: WsBaseUrl --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WsBaseUrl</maml:name> <maml:description> <maml:para>SDL Knowledge Center Content Manager web services main URL. Note that the URL is case-sensitive and should end with an ending slash! For example: "https://example.com/ISHWS/"</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshUserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshUserName</maml:name> <maml:description> <maml:para>Username to login into SDL Knowledge Center Content Manager</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshPassword</maml:name> <maml:description> <maml:para>Password to login into SDL Knowledge Center Content Manager</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout value expressed as TimeSpan, that controls Send/Receive timeouts of HttpClient when downloading content like connectionconfiguration.xml Defaults to 20 seconds.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:20</dev:defaultValue> </command:parameter> <!-- Parameter: TimeoutIssue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutIssue</maml:name> <maml:description> <maml:para>Timeout value expressed as TimeSpan, that controls Send/Receive timeouts of WCF when issuing a token. Defaults to maximum timespan.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10675199.02:48:05.4775807</dev:defaultValue> </command:parameter> <!-- Parameter: TimeoutService --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutService</maml:name> <maml:description> <maml:para>Timeout value expressed as TimeSpan, that controls Send/Receive timeouts of WCF for InfoShareWS proxies. Defaults to maximum timespan.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10675199.02:48:05.4775807</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreSslPolicyErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreSslPolicyErrors</maml:name> <maml:description> <maml:para>IgnoreSslPolicyErrors presence indicates that a custom callback will be assigned to ServicePointManager.ServerCertificateValidationCallback. Defaults false of course, as this is creates security holes! But very handy for Fiddler usage though.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: PSCredentialAuthGroup --> <command:syntaxItem> <maml:name>New-IshSession</maml:name> <!-- Parameter: WsBaseUrl --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WsBaseUrl</maml:name> <maml:description> <maml:para>SDL Knowledge Center Content Manager web services main URL. Note that the URL is case-sensitive and should end with an ending slash! For example: "https://example.com/ISHWS/"</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PSCredential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PSCredential</maml:name> <maml:description> <maml:para>Standard PowerShell Credential class</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout value expressed as TimeSpan, that controls Send/Receive timeouts of HttpClient when downloading content like connectionconfiguration.xml Defaults to 20 seconds.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:20</dev:defaultValue> </command:parameter> <!-- Parameter: TimeoutIssue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutIssue</maml:name> <maml:description> <maml:para>Timeout value expressed as TimeSpan, that controls Send/Receive timeouts of WCF when issuing a token. Defaults to maximum timespan.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10675199.02:48:05.4775807</dev:defaultValue> </command:parameter> <!-- Parameter: TimeoutService --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutService</maml:name> <maml:description> <maml:para>Timeout value expressed as TimeSpan, that controls Send/Receive timeouts of WCF for InfoShareWS proxies. Defaults to maximum timespan.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10675199.02:48:05.4775807</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreSslPolicyErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreSslPolicyErrors</maml:name> <maml:description> <maml:para>IgnoreSslPolicyErrors presence indicates that a custom callback will be assigned to ServicePointManager.ServerCertificateValidationCallback. Defaults false of course, as this is creates security holes! But very handy for Fiddler usage though.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: WsBaseUrl --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WsBaseUrl</maml:name> <maml:description> <maml:para>SDL Knowledge Center Content Manager web services main URL. Note that the URL is case-sensitive and should end with an ending slash! For example: "https://example.com/ISHWS/"</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PSCredential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PSCredential</maml:name> <maml:description> <maml:para>Standard PowerShell Credential class</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshUserName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshUserName</maml:name> <maml:description> <maml:para>Username to login into SDL Knowledge Center Content Manager</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshPassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshPassword</maml:name> <maml:description> <maml:para>Password to login into SDL Knowledge Center Content Manager</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Timeout value expressed as TimeSpan, that controls Send/Receive timeouts of HttpClient when downloading content like connectionconfiguration.xml Defaults to 20 seconds.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00:00:20</dev:defaultValue> </command:parameter> <!-- Parameter: TimeoutIssue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutIssue</maml:name> <maml:description> <maml:para>Timeout value expressed as TimeSpan, that controls Send/Receive timeouts of WCF when issuing a token. Defaults to maximum timespan.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10675199.02:48:05.4775807</dev:defaultValue> </command:parameter> <!-- Parameter: TimeoutService --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutService</maml:name> <maml:description> <maml:para>Timeout value expressed as TimeSpan, that controls Send/Receive timeouts of WCF for InfoShareWS proxies. Defaults to maximum timespan.</maml:para> </maml:description> <command:parameterValue required="true">TimeSpan</command:parameterValue> <dev:type> <maml:name>System.TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>10675199.02:48:05.4775807</dev:defaultValue> </command:parameter> <!-- Parameter: IgnoreSslPolicyErrors --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreSslPolicyErrors</maml:name> <maml:description> <maml:para>IgnoreSslPolicyErrors presence indicates that a custom callback will be assigned to ServicePointManager.ServerCertificateValidationCallback. Defaults false of course, as this is creates security holes! But very handy for Fiddler usage though.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: IshSession --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "admin" -IshPassword "admin"</dev:code> <dev:remarks> <maml:para>Building a session for the chosen service based on username/password authentication. The username/password will be used to build a NetworkCredential object to pass for authentication to the service.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/"</dev:code> <dev:remarks> <maml:para>Building a session for the chosen service based on Active Directory authentication. An implicit NetworkCredential object will be passed for authentication to the service.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential "Admin"</dev:code> <dev:remarks> <maml:para>Iteratively the New-IshSession line with PSCredential parameter holding a string representation will prompt you for a password.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "admin" -IshPassword "admin" -Timeout (New-TimeSpan -Seconds 30)</dev:code> <dev:remarks> <maml:para>Building a session for the chosen service based on username/password authentication. The Timeout parameter, expressed as TimeSpan object, controls Send/Receive timeouts of HttpClient when downloading content like connectionconfiguration.xml.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "admin" -IshPassword "admin" -TimeoutIssue (New-TimeSpan -Seconds 120) -TimeoutService (New-TimeSpan -Seconds 600)</dev:code> <dev:remarks> <maml:para>Building a session for the chosen service based on username/password authentication. The Timeout parameters, expressed as TimeSpan objects, control Send/Receive timeouts of WCF when issuing a token or working with proxies.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>$securePassword = ConvertTo-SecureString "MYPASSWORD" -AsPlainText -Force $mycredentials = New-Object System.Management.Automation.PSCredential("MYISHUSERNAME", $securePassword) New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential $mycredentials</dev:code> <dev:remarks> <maml:para>Extensive automation example based on the PSCredential parameter. Responsibility of the plain text password is yours.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 7 ----------</maml:title> <dev:code>$DebugPreference = "Continue" $VerbosePreference = "Continue" $ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/Internal/" -IshUserName "admin" -IshPassword "admin"</dev:code> <dev:remarks> <maml:para>When ISHDeploy Enable-ISHIntegrationSTSInternalAuthentication was executed on the server, the web services are directed to a secondary Secure Token Service (STS). This happens through the '/Internal/' postfix which in essence points to a different connectionconfiguration.xml for initialization.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 8 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/Internal/" -IshUserName "admin" -IshPassword "admin" -IgnoreSslPolicyErrors</dev:code> <dev:remarks> <maml:para>IgnoreSslPolicyErrors presence indicates that a custom callback will be assigned to ServicePointManager.ServerCertificateValidationCallback. Defaults false of course, as this is creates security holes! But very handy for Fiddler usage though.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-IshSetting --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-IshSetting</command:name> <command:verb>Get</command:verb> <command:noun>IshSetting</command:noun> <maml:description> <maml:para>This cmdlet can be used to get a configuration setting from the repository. Depending on the parameters you use, the setting will be returned differently. If you provide: * A requested metadata parameter with the fields to get, the setting will be return as IshFields * A fieldname and no filepath, the setting will be returned as string * A fieldname and a filepath, the setting will be saved to the file. If the file is already present, providing -Force will allow you to overwrite the file</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet can be used to get a configuration setting from the repository. Depending on the parameters you use, the setting will be returned differently. If you provide: * A requested metadata parameter with the fields to get, the setting will be return as IshFields * A fieldname and no filepath, the setting will be returned as string * A fieldname and a filepath, the setting will be saved to the file. If the file is already present, providing -Force will allow you to overwrite the file</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Get-IshSetting</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FieldName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The settings field to retrieve</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>File on the Windows filesystem where to save the retrieved setting</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>When set, will override the file when it already exists</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: RequestedMetadataGroup --> <command:syntaxItem> <maml:name>Get-IshSetting</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FieldName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The settings field to retrieve</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>File on the Windows filesystem where to save the retrieved setting</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>When set, will override the file when it already exists</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: FileInfo --> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: IshField --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Holds one field metadata entry described by a name, optional level and value</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Param( $wsBaseUrl = 'https://example.com/InfoShareWS/', $userName = 'admin', $password = 'admin', $settingsFolderPath = 'D:\temp' ) $ishSession = New-IshSession -WsBaseUrl $wsBaseUrl -IshUserName $userName -IshPassword $password $settingsFolderPath = Join-Path -Path $settingsFolderPath -ChildPath ((Get-Date -Format yyyyMMddHHmmss) + "=" + $wsBaseUrl.Replace(":","-").Replace("/","-") + "=" + (Get-IshVersion $ishSession).ToString()) Write-Verbose "Saving in $settingsFolderPath" $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLInboxConfiguration.xml" Get-IshSetting -IshSession $ishSession -FieldName "FINBOXCONFIGURATION" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLBackgroundTaskConfiguration.xml" Get-IshSetting -IshSession $ishSession -FieldName "FISHBACKGROUNDTASKCONFIG" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLChangeTrackerConfig.xml" Get-IshSetting -IshSession $ishSession -FieldName "FISHCHANGETRACKERCONFIG" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLExtensionConfiguration.xml" Get-IshSetting -IshSession $ishSession -FieldName "FISHEXTENSIONCONFIG" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLPluginConfig.xml" Get-IshSetting -IshSession $ishSession -FieldName "FISHPLUGINCONFIGXML" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLStatusConfiguration.xml" Get-IshSetting -IshSession $ishSession -FieldName "FSTATECONFIGURATION" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLTranslationConfiguration.xml" Get-IshSetting -IshSession $ishSession -FieldName "FTRANSLATIONCONFIGURATION" -FilePath $filePath $filePath = Join-Path -Path $settingsFolderPath -ChildPath "Admin.XMLWriteObjPluginConfig.xml" Get-IshSetting -IshSession $ishSession -FieldName "FISHWRITEOBJPLUGINCFG" -FilePath $filePath Write-Host "Done, see $settingsFolderPath"</dev:code> <dev:remarks> <maml:para>Retrieve all Settings xml configuration entries and save them in a folder to desk allowing file-to-file comparison with EnterViaUI folder.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-IshSetting --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-IshSetting</command:name> <command:verb>Set</command:verb> <command:noun>IshSetting</command:noun> <maml:description> <maml:para>This cmdlet can be used to set a configuration setting in the repository. Depending on the parameters you use, the value to set is read from different inputs. If you provide: * A metadata parameter with the fields to set, all fields and values will be read from the IshFields and set * A fieldname and a value, the value will be set for the given field * A fieldname and a filepath, the value will be read from the file and set for the given field</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet can be used to set a configuration setting in the repository. Depending on the parameters you use, the value to set is read from different inputs. If you provide: * A metadata parameter with the fields to set, all fields and values will be read from the IshFields and set * A fieldname and a value, the value will be set for the given field * A fieldname and a filepath, the value will be read from the file and set for the given field</maml:para> </maml:description> <command:syntax> <!-- Parameter set: IshFieldsGroup --> <command:syntaxItem> <maml:name>Set-IshSetting</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata with the fields and values to set</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the setting. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</maml:para> <maml:para>If the metadata is still the same, the metadata will be set.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the metadata will be set.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ValueGroup --> <command:syntaxItem> <maml:name>Set-IshSetting</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FieldName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The settings field to set</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>The value to set</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the setting. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</maml:para> <maml:para>If the metadata is still the same, the metadata will be set.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the metadata will be set.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: FileGroup --> <command:syntaxItem> <maml:name>Set-IshSetting</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FieldName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The settings field to set</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>File on the Windows filesystem where to read the setting from</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the setting. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</maml:para> <maml:para>If the metadata is still the same, the metadata will be set.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the metadata will be set.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata with the fields and values to set</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FieldName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FieldName</maml:name> <maml:description> <maml:para>The settings field to set</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Value --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>The value to set</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilePath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>File on the Windows filesystem where to read the setting from</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequiredCurrentMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequiredCurrentMetadata</maml:name> <maml:description> <maml:para>The required current metadata of the setting. This parameter can be used to avoid that users override changes done by other users. The cmdlet will check whether the fields provided in this parameter still have the same values in the repository:</maml:para> <maml:para>If the metadata is still the same, the metadata will be set.</maml:para> <maml:para>If the metadata is not the same anymore, an error is given and the metadata will be set.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: IshFields --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.IshFields</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Container object to group multiple IshField entries, eaching holding one field metadata entry described by a name, optional level and value</maml:para> <maml:para>Should not be used as cmdlet parameter, single IshField and IshField[] are more PowerShell friendly.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-IshTimeZone --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-IshTimeZone</command:name> <command:verb>Get</command:verb> <command:noun>IshTimeZone</command:noun> <maml:description> <maml:para>This cmdlet returns the time zone information of the web/app server. This cmdlet can also be used to measure the latency between the client and the server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet returns the time zone information of the web/app server. This cmdlet can also be used to measure the latency between the client and the server. ClientElapsed - either Min, Average or Max - indicates the time taken to execute the web service call measured from the client. AppServerElapsed - either Min, Average or Max - indicates the time taken to execute the database query measured on the web/app server. DbServerElapsed - either Min, Average or Max - indicates the time taken to execute the database query measured on the database server. By performing multiple calls using the Count parameter you will get a better idea on variation on the calls. Client and app server network latency is calculated through: ClientElapsed - AppServerElapsed. App server and db server network latency is calculated through: AppServerElapsed - DbServerElapsed.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-IshTimeZone</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>The amount off get timezone webservice call you wish to perform.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Count --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>The amount off get timezone webservice call you wish to perform.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: IshApplicationSetting --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshApplicationSetting</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Holds a single result of the GetTimeZone call containing network timestamps</maml:para> </maml:description> </command:returnValue> <!-- OutputType: IshApplicationSettings --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshApplicationSettings</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Container holding multiple results of GetTimeZone calls containing network timestamps allowing basic network statistics verification and calculation</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Get-IshTimeZone -IshSession $ishSession </dev:code> <dev:remarks> <maml:para>Creates an IshApplicationSetting structure some timings but especially holds the TimeZoneInfo of the targeted application server.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -PSCredential Admin Get-IshTimeZone -IshSession $ishSession -Count 2</dev:code> <dev:remarks> <maml:para>Creates an IshApplicationSettings structure holds the TimeZoneInfo of the targeted application server. But especially holds time difference between client requests, application-server requests and database-server requests.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Compare-IshTypeFieldDefinition --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Compare-IshTypeFieldDefinition</command:name> <command:verb>Compare</command:verb> <command:noun>IshTypeFieldDefinition</command:noun> <maml:description> <maml:para>This cmdlet compares two IshTypeFieldDefinition sets.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet compares two IshTypeFieldDefinition sets allowing system compares (or even a compare with the deprecated TriDKXmlSetup format). The result is an IshTypeFieldDefinition with a Compare property indicating equal, different, left only or right only. Note that fields FDESCRIPTION and FCHANGES can have either type String or LongText, you can consider this false positives - this will only affect field filter operators.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Compare-IshTypeFieldDefinition</maml:name> <!-- Parameter: LeftIshSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LeftIshSession</maml:name> <maml:description> <maml:para>The reference object of type IshSession</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LeftIshTypeFieldDefinition --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LeftIshTypeFieldDefinition</maml:name> <maml:description> <maml:para>The reference object of type IshTypeFieldDefinition array</maml:para> </maml:description> <command:parameterValue required="true">IshTypeFieldDefinition[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinition[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RightIshSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RightIshSession</maml:name> <maml:description> <maml:para>The difference object of type IshSession</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: RightIshTypeFieldDefinition --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RightIshTypeFieldDefinition</maml:name> <maml:description> <maml:para>The difference object of type IshTypeFieldDefinition array</maml:para> </maml:description> <command:parameterValue required="true">IshTypeFieldDefinition[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinition[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeIdentical --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeIdentical</maml:name> <maml:description> <maml:para>Display characteristics of compared objects that are equal. By default, only characteristics that differ between the left and right objects are displayed.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludeDifferent --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeDifferent</maml:name> <maml:description> <maml:para>Stop displaying characteristics of compared objects that are different.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludeLeftUnique --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeLeftUnique</maml:name> <maml:description> <maml:para>Stop displaying characteristics of compared objects that are unique in the left reference object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludeRightUnique --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeRightUnique</maml:name> <maml:description> <maml:para>Stop displaying characteristics of compared objects that are unique in the right difference object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: LeftIshSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LeftIshSession</maml:name> <maml:description> <maml:para>The reference object of type IshSession</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: LeftIshTypeFieldDefinition --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LeftIshTypeFieldDefinition</maml:name> <maml:description> <maml:para>The reference object of type IshTypeFieldDefinition array</maml:para> </maml:description> <command:parameterValue required="true">IshTypeFieldDefinition[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinition[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RightIshSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RightIshSession</maml:name> <maml:description> <maml:para>The difference object of type IshSession</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: RightIshTypeFieldDefinition --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RightIshTypeFieldDefinition</maml:name> <maml:description> <maml:para>The difference object of type IshTypeFieldDefinition array</maml:para> </maml:description> <command:parameterValue required="true">IshTypeFieldDefinition[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinition[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeIdentical --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeIdentical</maml:name> <maml:description> <maml:para>Display characteristics of compared objects that are equal. By default, only characteristics that differ between the left and right objects are displayed.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludeDifferent --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeDifferent</maml:name> <maml:description> <maml:para>Stop displaying characteristics of compared objects that are different.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludeLeftUnique --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeLeftUnique</maml:name> <maml:description> <maml:para>Stop displaying characteristics of compared objects that are unique in the left reference object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludeRightUnique --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeRightUnique</maml:name> <maml:description> <maml:para>Stop displaying characteristics of compared objects that are unique in the right difference object.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: IshTypeFieldDefinitionCompare --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinitionCompare</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object holding the denormalized ISHType (like ISHMasterDoc, ISHEvent,...) with field information (like FTITLE, PROGRESS,..) including a compare result.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSessionA = New-IshSession -WsBaseUrl "https://example.com/InfoShareWSPRODUCATION/" -PSCredential "Admin" $ishSessionB = New-IshSession -WsBaseUrl "https://example.com/InfoShareWSTEST/" -PSCredential "Admin" Compare-IshTypeFieldDefinition -LeftIshSession $ishSessionA -RightIshSession $ishSessionB</dev:code> <dev:remarks> <maml:para>Compares incoming IshSession entries that are not equal, so indicating differences, left only and right only.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>$ishSessionA = New-IshSession -WsBaseUrl "https://example.com/InfoShareWSPRODUCATION/" -PSCredential "Admin" $ishSessionB = New-IshSession -WsBaseUrl "https://example.com/InfoShareWSTEST/" -PSCredential "Admin" Compare-IshTypeFieldDefinition -LeftIshSession $ishSessionA -RightIshSession $ishSessionB -ExcludeLeftUnique</dev:code> <dev:remarks> <maml:para>Compares incoming IshSession entries that are not equal, so indicating differences and right only changes compared to the $ishSessionA reference.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWSPRODUCATION/" -PSCredential "Admin" $ishTypeFieldDefinitions = Get-IshTypeFieldDefinition -TriDKXmlSetupFilePath $tempFilePath Compare-IshTypeFieldDefinition -LeftIshTypeFieldDefinition $ishTypeFieldDefinitions -RightIshSession $ishSession -ExcludeLeftUnique</dev:code> <dev:remarks> <maml:para>Compares provided reference TriDKXmlSetup export file with incoming IshSession and that lists differences and right only changes.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWSPRODUCATION/" -PSCredential "Admin" $ishTypeFieldDefinitions = Get-IshTypeFieldDefinition Compare-IshTypeFieldDefinition -LeftIshSession $ishSession -RightIshTypeFieldDefinition $ishTypeFieldDefinitions -IncludeIdentical -ExcludeDifferent</dev:code> <dev:remarks> <maml:para>Compares incoming IshSession and IshTypeFieldDefinitions (TriDKXmlSetup export file made available through Resource entry). The IncludeIdentical flag will also return matching rows, while the ExcludeDifferent flag will not return rows with differences.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWSPRODUCATION/" -PSCredential "Admin" $ishTypeFieldDefinitions = Get-IshTypeFieldDefinition Compare-IshTypeFieldDefinition -LeftIshTypeFieldDefinition $ishTypeFieldDefinitions -RightIshSession $ishSession -IncludeIdentical | Where-Object -Property Name -NotLike "FTEST*" | Out-GridView</dev:code> <dev:remarks> <maml:para>Compares reference IshTypeFieldDefinitions (TriDKXmlSetup export file made available through Resource entry) with incoming IshSession. The IncludeIdentical flag will also return matching rows, while the Where-Object clause filters out fields with a certain name. The PowerShell Out-GridView does a nice visual rendering in PowerShell ISE.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-IshTypeFieldDefinition --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-IshTypeFieldDefinition</command:name> <command:verb>Get</command:verb> <command:noun>IshTypeFieldDefinition</command:noun> <maml:description> <maml:para>This cmdlet retuns the system Type and Field definitions as IshTypeFieldDefinition objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet will use Settings25.RetrieveFieldSetupByIshType when available. It can be used to load the deprecated TriDKXmlSetup format into IshTypeFieldDefinition objects.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-IshTypeFieldDefinition</maml:name> <!-- Parameter: IshSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: TriDKXmlSetupFilePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TriDKXmlSetupFilePath</maml:name> <maml:description> <maml:para>File on the Windows filesystem where to load the TriDKXmlSetup full export from</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: TriDKXmlSetupFilePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TriDKXmlSetupFilePath</maml:name> <maml:description> <maml:para>File on the Windows filesystem where to load the TriDKXmlSetup full export from</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: IshTypeFieldDefinition --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshTypeFieldDefinition</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Object holding the denormalized ISHType (like ISHMasterDoc, ISHEvent,...) with field information (like FTITLE, PROGRESS,..).</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-IshTypeFieldDefinition | Where-Object -Property ISHType -eq "ISHUser"</dev:code> <dev:remarks> <maml:para>Without IshSession the latest internal resource string will be loaded (based on Full-Export). The Where-Object allows filtering on chosen properties.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" Get-IshTypeFieldDefinition -IshSession $ishSession</dev:code> <dev:remarks> <maml:para>When ServerVersion -ge 13.0.0 the definition of your targeted IshSession is retrieved, otherwise the best matching internal resource string will be loaded (based on Full-Export).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Get-IshTypeFieldDefinition -IshSession $ishSession | Where-Object -Property ISHType -eq ISHUser | Where-Object -Property AllowOnCreate -eq $true | Where-Object -Property IsMandatory -eq $true</dev:code> <dev:remarks> <maml:para>What are the fields I should pass when creating a new user through Add-IshUser.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-IshUser --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-IshUser</command:name> <command:verb>Add</command:verb> <command:noun>IshUser</command:noun> <maml:description> <maml:para>The Add-IshUser cmdlet adds the new users that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-IshUser cmdlet adds the new users that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Add-IshUser</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new user.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata to set for the new user.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectGroup --> <command:syntaxItem> <maml:name>Add-IshUser</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the users to create. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the users to create. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new user.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata to set for the new user.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the users to create. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" $metadata = Set-IshMetadataField -IshSession $ishSession -Name FISHUSERLANGUAGE -Level None -ValueType Element -Value "VLANGUAGEEN" | Set-IshMetadataField -IshSession $ishSession -Name FUSERGROUP -Level None -ValueType Element -Value "VUSERGROUPDEFAULTDEPARTMENT" | Set-IshMetadataField -IshSession $ishSession -Name PASSWORD -Level None -Value "SomethingSecret" $ishObject = Add-IshUser -IshSession $ishSession -Name "NewUserName" -Metadata $metadata</dev:code> <dev:remarks> <maml:para>Adding a user</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Find-IshUser --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Find-IshUser</command:name> <command:verb>Find</command:verb> <command:noun>IshUser</command:noun> <maml:description> <maml:para>The Find-IshUser cmdlet finds users using ActivityFilter and MetadataFilter that are provided</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Find-IshUser cmdlet finds users using ActivityFilter and MetadataFilter that are provided</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Find-IshUser</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-IshUser --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-IshUser</command:name> <command:verb>Get</command:verb> <command:noun>IshUser</command:noun> <maml:description> <maml:para>The Get-IshUser cmdlet retrieves the metadata of users that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-IshUser cmdlet retrieves the metadata of users that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Get-IshUser</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The user identifiers for which to retrieve the metadata</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Get-IshUser</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Users for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: MyMetadataGroup --> <command:syntaxItem> <maml:name>Get-IshUser</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The user identifiers for which to retrieve the metadata</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Users for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Users for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Remove-IshUser --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-IshUser</command:name> <command:verb>Remove</command:verb> <command:noun>IshUser</command:noun> <maml:description> <maml:para>The Remove-IshUser cmdlet removes the users that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-IshUser cmdlet removes the users that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Remove-IshUser</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The identifier of the user to remove</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectGroup --> <command:syntaxItem> <maml:name>Remove-IshUser</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the users to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The identifier of the user to remove</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the users to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the users to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Set-IshUser --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-IshUser</command:name> <command:verb>Set</command:verb> <command:noun>IshUser</command:noun> <maml:description> <maml:para>The Set-IshUser cmdlet updates the users that are passed through the pipeline or determined via provided parameters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-IshUser cmdlet updates the users that are passed through the pipeline or determined via provided parameters.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Set-IshUser</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The identifier of the user to update</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata to set for the user</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Set-IshUser</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Users for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The identifier of the user to update</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata to set for the user</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Users for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Users for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Add-IshUserGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-IshUserGroup</command:name> <command:verb>Add</command:verb> <command:noun>IshUserGroup</command:noun> <maml:description> <maml:para>The Add-IshUserGroup cmdlet adds the new user groups that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-IshUserGroup cmdlet adds the new user groups that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Add-IshUserGroup</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new user group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata to set on the new user group.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Add-IshUserGroup</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the user groups to create. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the user groups to create. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new user group.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata to set on the new user group.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the user groups to create. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Find-IshUserGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Find-IshUserGroup</command:name> <command:verb>Find</command:verb> <command:noun>IshUserGroup</command:noun> <maml:description> <maml:para>The Find-IshUserGroup cmdlet finds user groups using ActivityFilter and MetadataFilter that are provided.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Find-IshUserGroup cmdlet finds user groups using ActivityFilter and MetadataFilter that are provided.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Find-IshUserGroup</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" Find-IshUserGroup -IshSession $ishSession -RequestedMetadata (Set-IshRequestedMetadataField -IshSession $ishSession -Name "FISHUSERGROUPNAME")</dev:code> <dev:remarks> <maml:para>Retrieve all user groups</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-IshUserGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-IshUserGroup</command:name> <command:verb>Get</command:verb> <command:noun>IshUserGroup</command:noun> <maml:description> <maml:para>The Get-IshUserGroup cmdlet retrieves the metadat of user groups that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-IshUserGroup cmdlet retrieves the metadat of user groups that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Get-IshUserGroup</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The user group identifiers for which to retrieve the metadata</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Get-IshUserGroup</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the user groups for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The user group identifiers for which to retrieve the metadata</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the user groups for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the user groups for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Remove-IshUserGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-IshUserGroup</command:name> <command:verb>Remove</command:verb> <command:noun>IshUserGroup</command:noun> <maml:description> <maml:para>The Remove-IshUserGroup cmdlet removes the user groups that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-IshUserGroup cmdlet removes the user groups that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Remove-IshUserGroup</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The identifier of the user group to remove</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Remove-IshUserGroup</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the user groups to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The identifier of the user group to remove</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the user groups to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the user groups to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Set-IshUserGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-IshUserGroup</command:name> <command:verb>Set</command:verb> <command:noun>IshUserGroup</command:noun> <maml:description> <maml:para>The Set-IshUserGroup cmdlet updates the user groups that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-IshUserGroup cmdlet updates the user groups that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Set-IshUserGroup</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The identifier of the user group to update</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata to set for the user group</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Set-IshUserGroup</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>User groups for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The identifier of the user group to update</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata to set for the user group</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>User groups for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>User groups for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Add-IshUserRole --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-IshUserRole</command:name> <command:verb>Add</command:verb> <command:noun>IshUserRole</command:noun> <maml:description> <maml:para>The Add-IshUserRole cmdlet adds the new user roles that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-IshUserRole cmdlet adds the new user roles that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Add-IshUserRole</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new user role.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata to set for the new user role.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Add-IshUserRole</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the user roles to create. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the user roles to create. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new user role.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata to set for the new user role.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the user roles to create. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Find-IshUserRole --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Find-IshUserRole</command:name> <command:verb>Find</command:verb> <command:noun>IshUserRole</command:noun> <maml:description> <maml:para>The Find-IshUserRole cmdlet finds user roles using ActivityFilter and MetadataFilter that are provided.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Find-IshUserRole cmdlet finds user roles using ActivityFilter and MetadataFilter that are provided.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Find-IshUserRole</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/InfoShareWS/" -IshUserName "username" -IshUserPassword "userpassword" Find-IshUserRole -IshSession $ishSession -RequestedMetadata (Set-IshRequestedMetadataField -IshSession $ishSession -Name "FISHUSERROLENAME")</dev:code> <dev:remarks> <maml:para>Retrieve all user roles</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-IshUserRole --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-IshUserRole</command:name> <command:verb>Get</command:verb> <command:noun>IshUserRole</command:noun> <maml:description> <maml:para>The Get-IshUserRole cmdlet retrieves the metadata of user roles that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-IshUserRole cmdlet retrieves the metadata of user roles that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Get-IshUserRole</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The user role identifiers for which to retrieve the metadata</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Get-IshUserRole</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the user roles for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: ActivityFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActivityFilter</maml:name> <maml:description> <maml:para>The activity filter to limit the amount of objects returned. Default is no filtering.</maml:para> <maml:para>Possible values: None, Active, Inactive</maml:para> </maml:description> <command:parameterValue required="true">ActivityFilter</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Enumerations+ActivityFilter</maml:name> <maml:uri /> <maml:description> <maml:para>List of value like Events can be hidden upon Find/Retrieval with these filters</maml:para> </maml:description> </dev:type> <dev:defaultValue>None</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">None</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inactive</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The user role identifiers for which to retrieve the metadata</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MetadataFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MetadataFilter</maml:name> <maml:description> <maml:para>The metadata filter with the filter fields to limit the amount of objects returned. Default is no filtering.</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RequestedMetadata --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestedMetadata</maml:name> <maml:description> <maml:para>The metadata fields to retrieve</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the user roles for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the user roles for which to retrieve the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Remove-IshUserRole --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-IshUserRole</command:name> <command:verb>Remove</command:verb> <command:noun>IshUserRole</command:noun> <maml:description> <maml:para>The Remove-IshUserRole cmdlet removes the user roles that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-IshUserRole cmdlet removes the user roles that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Remove-IshUserRole</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The identifier of the user role to remove</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Remove-IshUserRole</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the user roles to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The identifier of the user role to remove</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>Array with the user roles to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Array with the user roles to remove. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Set-IshUserRole --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-IshUserRole</command:name> <command:verb>Set</command:verb> <command:noun>IshUserRole</command:noun> <maml:description> <maml:para>The Set-IshUserRole cmdlet updates the user roles that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-IshUserRole cmdlet updates the user roles that are passed through the pipeline or determined via provided parameters</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ParameterGroup --> <command:syntaxItem> <maml:name>Set-IshUserRole</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The identifier of the user role to update</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata to set for the user role</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IshObjectsGroup --> <command:syntaxItem> <maml:name>Set-IshUserRole</maml:name> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>User roles for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IshSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IshSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The identifier of the user role to update</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Metadata --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>The metadata to set for the user role</maml:para> </maml:description> <command:parameterValue required="true">IshField[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshField[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IshObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>IshObject</maml:name> <maml:description> <maml:para>User roles for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> <command:parameterValue required="true">IshObject[]</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>User roles for which to update the metadata. This array can be passed through the pipeline or explicitly passed via the parameter.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: IshObject --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshObject</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Generic pipeline object for the API holding various references (logical id, card id,...), object type, ishfields (metadata ) and optionally ishdata (file/blob)</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-IshVersion --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-IshVersion</command:name> <command:verb>Get</command:verb> <command:noun>IshVersion</command:noun> <maml:description> <maml:para>The Get-Version cmdlet gets the version information of the InfoShare application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-Version cmdlet gets the version information of the InfoShare application.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-IshVersion</maml:name> <!-- Parameter: IShSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IShSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IShSession --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IShSession</maml:name> <maml:description> <maml:para>The IshSession variable holds the authentication and contract information. This object can be initialized using the New-IshSession cmdlet.</maml:para> </maml:description> <command:parameterValue required="true">IshSession</command:parameterValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshSession</maml:name> <maml:uri /> <maml:description> <maml:para>Client session object to the InfoShare server instance required for every remote operation as it holds the web service url and authentication.</maml:para> <maml:para>Furthermore it tracks your security token, provides direct client access to the web services API.</maml:para> <maml:para>Gives access to contract parameters like seperators, date formats, batch and chunk sizes.</maml:para> </maml:description> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: IshVersion --> <command:returnValue> <dev:type> <maml:name>Trisoft.ISHRemote.Objects.Public.IshVersion</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Stores a version number. It knows how to parse InfoShare version numbers regarding compatibility and build information</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>$ishSession = New-IshSession -WsBaseUrl "https://example.com/ISHWS/" -IshUserName "username" -IshUserPassword "userpassword" $version = Get-Version -IshSession $ishSession Write-Host $version</dev:code> <dev:remarks> <maml:para>Get version example</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> </helpItems> |