Interfaces do Conector do Cast Iron

Os conectores do Cast Iron utilizam três interfaces padrão, implementadas como orquestrações: TestConnection, ListObjects e DescribeObjects.

Os modelos de orquestração para as interfaces TestConnection, ListObjects e DescribeObjects são criados automaticamente pelo Assistente, durante a fase Incluir Atividades. Você deve concluir as orquestrações com base em requisitos de conector individuais. Esta seção introduz as interfaces TestConnection, ListObjects e DescribeObjects. No Concluindo Orquestrações da Interface do Conector, você conclui uma orquestração para cada uma.

TestConnection

A interface TestConnection reflete os valores incluídos na janela Informações de Conexão e é usada pelo conector para estabelecer uma conexão de terminal. Após a conexão ser estabelecida, o status da conexão é retornada como um operador booleano.

ListObjects

A interface ListObjects reflete os valores incluídos na janela Incluir Atividades e retorna uma lista de todos os objetos suportados por uma atividade de conector específica. Por exemplo, uma operação para criar uma Força de Vendas pode suportar objetos como Conta, Cliente, Contato, Oportunidade e Usuário, entre outros. A lista de retorno deverá corresponder a um esquema de Atividade Responder a ListObjects. A seguir um exemplo de uma resposta de ListObjects no formato XML:
<ListObjectsResponse
xmlns="http://www.approuter.com/schemas/cdk/api/">
<objectType
label="Customer"
xmlns="http://www.approuter.com/schemas/cdk/api/">Account</objectType>
<objectType
label="Account Object"
xmlns="http://www.approuter.com/schemas/cdk/api/">Customer</objectType>
<objectType
label="Customer details"
xmlns="http://www.approuter.com/schemas/cdk/api/">Contact</objectType>
<objectType
label="Opportunity details"
xmlns="http://www.approuter.com/schemas/cdk/api/">Opportunity</objectType>
<objectType
label="User details"
xmlns="http://www.approuter.com/schemas/cdk/api/">User</objectType>
</ListObjectsResponse>

DescribeObjects

A interface DescribeObjects fornece a entrada e saída que permite aos usuários trabalhar com sucesso com um objeto exposto por meio de uma atividade de conector. Por exemplo, se uma operação para criar Força de Vendas for selecionada, o esquema de entrada será descoberto de forma dinâmica com base em um objeto selecionado a partir de ListObjects. Eis um exemplo de uma resposta retornada por DescribeObjects:
<DescribeObjectResponse baseType="sObject" 
  baseTypeNS="urn:sobject.partner.soap.sforce.com" 
	name="create" typeNS="http://example.com/stockquote" 
	xmlns="http://www.approuter.com/schemas/cdk/api/"
	xmlns:con="http://www.approuter.com/schemas/cdk/config/" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<object label="createInput" maxCount="1" minCount="1" name="createInput"
		used="true">
		<con:field configurable="true" label="ObjectName" maxCount="1"
			minCount="1" name="ObjectName" used="true">
			<con:type>string</con:type>
		</con:field>
		<con:field configurable="true" label="FirstName" maxCount="1"
			minCount="1" name="FirstName" used="true">
			<con:type>string</con:type>
		</con:field>
		<con:field configurable="true" label="LastName" maxCount="1"
			minCount="1" name="LastName" used="true">
			<con:type>string</con:type>
		</con:field>
		<con:field configurable="true" label="Phone" maxCount="1"
			minCount="1" name="Phone" used="true">
			<con:type>string</con:type>
		</con:field>
	</object>
	<responseObject label="createOutput" maxCount="1"
		minCount="1" name="createOutput" used="true">
		<con:field configurable="true" label="Id" maxCount="1"
			minCount="1" name="Id" used="true">
			<con:type>string</con:type>
		</con:field>
		<con:field configurable="true" label="ObjectName" maxCount="1"
			minCount="1" name="ObjectName" used="true">
			<con:type>string</con:type>
		</con:field>
		<con:field configurable="true" label="Status" maxCount="1"
			minCount="1" name="Status" used="true">
			<con:type>string</con:type>
		</con:field>
	</responseObject>
</DescribeObjectResponse> 

Descoberta Dinâmica de Esquema

O recurso de descoberta do esquema DescribeObjects permite descobrir de forma dinâmica um esquema no tempo de execução. O esquema é importado para a orquestração quando toda atividade do conector utiliza um elemento de esquema como entrada ou saída. Se esquemas anteriormente importados precisarem ser descobertos usando complexType QName e substituídos dinamicamente como atividades de entrada ou saída, configure os atributos em resposta do DescribeObject, conforme mostrado no seguinte esquema:
< xsd:schema   targetNamespace = " urn.sample.stock
 " xmlns:xsd = "http://www.w3.org/2001/XMLSchema" >
 < xsd:element   name = "TradePriceRequest" >
 < xsd:complexType >
 < xsd:all >
 < xsd:element   name = "tickerSymbol"   type = "xsd:string"   />
 </ xsd:all >
 </ xsd:complexType >
 </ xsd:element >
 < xsd:complexType   name = "ciObject" ></ xsd:complexType >
 < xsd:complexType   name = " tradingPartner " >
 < xsd:sequence >
 < xsd:element   name = "partnerName"   type = "xsd:string"   />
 </ xsd:sequence >
 </ xsd:complexType >  

Por exemplo, para substituir o complexType tradingPartner no esquema anterior, configure as informações para descobrir o esquema e substitua de forma dinâmica, conforme mostrado no seguinte exemplo:

DescribeObject Response value to 
@name   -> tradingPartner [complexType name to be discovered]
@typeNS  ->  url.sample.stock [complexType namespace ]
@baseType -> http://www.approuter.com/schemas/cdk/api/    [CDK default]
@baseType -> cObject [CDK default]
Exemplo de menu de descrição de objetos



Feedback | notices