Arquivo De Configuração De Ferramenta

Last modified: August 05, 2022

Cada plugin requer um arquivo de configuração, um arquivo GUI, um arquivo de mecanismo e um ícone de ferramenta. Consulte criar ferramentas personalizadas.

O nome do arquivo de configuração deve ser o nome do diretório com o sufixo config e o arquivo extension. xml.

\bin\HtmlPlugins\MyNiftyPlugin\MyNiftyPluginConfig.xml

Se sua ferramenta usa o SDK do Python como seu mecanismo, o nome da ferramenta, conforme definido na marca do arquivo de configuração, não pode conter espaços ou caracteres especiais. Para a legibilidade, o caso do camelo é recomendado.

Exemplo XML

    XML
    <AlteryxJavaScriptPlugin>
    	<EngineSettings EngineDll="Macro" 
    	EngineDllEntryPoint="MyNiftyPlugin\Supporting_Macros\MyNiftyMacro.yxmc" />
     	<GuiSettings Html="JavaScriptCountEngine.html" 
    	Help="www.example.com/JavaScriptCountGui.html" Icon="JavaScriptCountIcon.png">
    		<InputConnection>
    			<Connection Name="Input1" AllowMultiple="False" Optional="True" 
    			Type="Connection" Label="I" />
    		</InputConnection>
    		<OutputConnection>
    			Connection Name="Output" AllowMultiple="True" Optional="True" 
    			Type="Connection" Label="O" />
    		</OutputConnection>
    	</GuiSettings>
    	<Properties>
    		<MetaInfo>
    			<NameIsFileName value="false" />
    			<Name>Hello World</Name>
    			<Description>Designer wants to say hello!</Description>
    			<RootToolName>HelloWorldMacro.yxmc</RootToolName>
    			<ToolVersion>1.0.0</ToolVersion>
    			<ToolInDb value="false" />
    			<CategoryName>SDK Examples</CategoryName>
    			<Author>Alteryx, Inc.</Author>
    			<Company>Alteryx, Inc.</Company>
    			<DescriptionLink actual="" display="" />
    		</MetaInfo>
    	</Properties>
    </AlteryxJavaScriptPlugin>

    O arquivo deve conter a tag com dois filhos:

    • Elemento EngineSettings: como o plug-in interage com o mecanismo de designer.

      Atributo Obrigatório Configurações
      O EngineDll Sim

      Defina como macro se o back-end for uma macro existente.

      Defina como o nome do plugin se usando qualquer outro plugin dll.

      Método EngineDllEntryPoint Sim

      Se EngineDll é definido como macro, defina como o nome do arquivo de macro.

      Caso contrário, defina como o nome do ponto de entrada de função no plug-in do mecanismo correspondente.

      O arquivo deve aderir à API de plug-in do mecanismo.

      SdkVersion Sim Defina como qualquer número de versão válido, como 10,1.
    • Elemento GuiSettings: como o plugin interage com a GUI do designer.

      Atributo Obrigatório Configurações
      Ajuda Não

      Deixe em branco para referenciar HTML-. Se o nome do diretório contiver espaços, os espaços serão removidos ao gerar o nome do arquivo. O nome do diretório não pode conter:/? # [] @! $ &'(,; =

      Defina como a URL completa para uma página de ajuda personalizada.

      Html Sim Defina como o nome do arquivo HTML5 que contém o componente GUI do seu plug-in.
      Ícone Não Defina como o nome de um arquivo. png contendo o ícone do seu plug-in.
      SdkVersion Sim Defina como qualquer número de versão válido, como 10,1.
    • Elemento OutputConnections: definir parâmetros para fluxos de dados de saída.

      Atributo Obrigatório Configurações
      Nome Sim O nome da guia de entrada.
      Allowmultiple Não Defina como true para permitir várias conexões em uma guia.
      Opcional Não Defina como true se a conexão for opcional.
      Tipo Não Definido como Connection.
      Rótulo Não Defina como um único caractere para criar um rótulo para a conexão de entrada.
    • Elemento InputConnections: define parâmetros para fluxos de dados recebidos.

      Atributo Obrigatório Configurações
      Nome Sim O nome da guia de entrada.
      Allowmultiple Não Defina como true para permitir várias conexões em uma guia.
      Opcional Não Defina como true se a conexão for opcional.
      Tipo Não Definido como Connection.
      Rótulo Não Defina como um único caractere para criar um rótulo para a conexão de entrada.

    Construa sua própria lista de verificação de ferramentas

    Esta página foi útil?

    Problemas com seu produto Alteryx? Visite a Comunidade Alteryx ou entre em contato com nossa Equipe de Suporte. Não é possível enviar este formulário? Envie-nos um e-mail.