Citrix Daas SDK

New-BrokerConfiguredFTA

August 9, 2024

Contributed by:

C C

Creates a file type association with a published application.

Syntax

New-BrokerConfiguredFTA
   -ApplicationUid <Int32>
   -ImportedFTA <ImportedFTA>
   [-UUID <Guid>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

New-BrokerConfiguredFTA
   -ApplicationUid <Int32>
   -ExtensionName <String>
   [-ContentType <String>]
   -HandlerName <String>
   [-HandlerDescription <String>]
   [-HandlerOpenArguments <String>]
   [-UUID <Guid>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Creates an association between a file type and a published application for the purposes of the content redirection.

File type association associates a file extension (such as “.txt”) with an application (such as Notepad). In a Citrix environment file type associations on a user device can be configured so that when an user clicks on a document it launches the appropriate published application. This is known as “content redirection”.

Configured file type associations are different from imported file type associations. Configured file type associations are those that are actually associated with published applications for the purposes of content redirection. Imported file type associations are lists of known file type associations for a given desktop group. See Update-BrokerImportedFTA for more information about imported file type associations.

This cmdlet has two parameter sets, which correspond to the cmdlet’s two use cases.

The first use case leverages imported file type associations to configure file types for published applications. Information about the file type association is read from the imported object. See the Update-BrokerImportedFTA cmdlet for more information about importing file type associations from a worker machine.

The second use case is more complex and allows you to create your own file type association without having to import it first. This also lets you create custom file type associations that may not already exist on the worker machines. This use case is more error-prone, however, because the individual attributes of the file type association must be correctly specified by you.

Examples

EXAMPLE 1

Gets the Uid for the application, gets the ImportedFTA

object for the file extension, and finally associates “.txt” with the

published “Notepad” application.

Note that the Get-BrokerImportedFTA cmdlet may return more than one

ImportedFTA objects for a specific extension name. See the help for

that cmdlet for more details.

$app = Get-BrokerApplication "Notepad"
$fta = Get-BrokerImportedFTA -ExtensionName ".txt"
New-BrokerConfiguredFTA -ImportedFTA $fta -ApplicationUid $app.Uid
<!--NeedCopy-->

EXAMPLE 2

This example is identical to the first, but shows the

the second use case of the cmdlet, specifying each attribute manually.

$app = Get-BrokerApplication "Notepad"
New-BrokerConfiguredFTA -ApplicationUid $app.Uid -ExtensionName ".txt" -HandlerName "txtfile" -ContentType "text\plain" -HandlerDescription "Text Document" -HandlerOpenArguments "%1"
<!--NeedCopy-->

Parameters

-ApplicationUid

Specifies the application with which the file type should be

associated.

Type:	Int32
Position:	Named
Default value:	(required)
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-ImportedFTA

Specifies the ImportedFTA object to use for creating the

ConfiguredFTA object. All values needed to create a ConfiguredFTA

object are read from the ImportedFTA object.

Type:	ImportedFTA
Position:	Named
Default value:	(required)
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-ExtensionName

Specifies the extension name for the file type association.

For example, “.txt” or “.doc”.

Type:	String
Position:	Named
Default value:	(required)
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	True

-HandlerName

Specifies the name of the handler for the file type

association (as seen in the Registry). For example, “TXTFILE” or

“Word.Document.8”.

Type:	String
Position:	Named
Default value:	(required)
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	True

-UUID

An optional GUID for this ConfiguredFTA.

Type:	Guid
Position:	Named
Default value:	A new GUID is generated if none is supplied.
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LoggingId

Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ContentType

Specifies the content type of the file type (as listed in

the Registry). For example, content type would be “text/plain” or

“application/msword”.

Type:	String
Position:	Named
Default value:	Null
Required:	False
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	True

-HandlerDescription

Specifies the description of the handler for the file type

association.

Type:	String
Position:	Named
Default value:	Null
Required:	False
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	True

-HandlerOpenArguments

Specifies the arguments for the open command that the

handler should use. For example, “%1”.

Type:	String
Position:	Named
Default value:	Null
Required:	False
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	True

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You can’t pipe objects to this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.ConfiguredFTA

This cmdlet returns a single ConfiguredFTA object.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

New-BrokerConfiguredFTA

August 9, 2024

Contributed by:

C C

August 9, 2024

Contributed by:

C C

New-BrokerConfiguredFTA

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-ApplicationUid

-ImportedFTA

-ExtensionName

-HandlerName

-UUID

-LoggingId

-ContentType

-HandlerDescription

-HandlerOpenArguments

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.Broker.Admin.SDK.ConfiguredFTA

Related Links

In this article