< Back

Export-CrmEntityRibbonXml

Sat Jan 18, 2020 3:58 pm

NAME Export-CrmEntityRibbonXml



SYNOPSIS

Retrieves the ribbon definition XML for an Entity and saves it to a file on the file system.





SYNTAX

Export-CrmEntityRibbonXml [-conn <CrmServiceClient>] [-EntityLogicalName] <String> [[-RibbonFilePath] <String>]

[<CommonParameters>]





DESCRIPTION

The Export-CrmEntityRibbonXml cmdlet lets you retrieve ribbon definition XML for an Entity.





PARAMETERS

-conn <CrmServiceClient>

A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-EntityLogicalName <String>

A logicalname for Entity. e.g.- account, contact, lead, etc..



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-RibbonFilePath <String>

The path to the desired output location. This should be a full file path, e.g.-c:\\temp



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS









OUTPUTS









NOTES









-------------------------- Example 1 --------------------------



Export-CrmEntityRibbonXml -conn $conn -EntityLogicalName account -RibbonFilePath c:\\temp



This example export the Ribbon XML for the account entity to c:\\temp\\accountRibbon.xml.









RELATED LINKS