This documentation supports the 9.1 to 9.1 Service Pack 3 version and its patches of BMC Atrium Core. The documentation for version 9.1.04 and its patches is available here.

To view the latest version, select the version from the Product version menu.

ActivateFederatedInContext function

Expands the FederatedInterface instance for a specific CI and federated interface. Depending on a flag you specify when you call this operation, your federated instance might either be only expanded, or expanded and launched.

WSDL operation

<operation name="ActivateFederatedInContext" 	
	parameterOrder="inargs">
<input message="tns:ActivateFederatedInContextRequest"
	name="ActivateFederatedInContextRequest"/>
<output message="tns:ActivateFederatedInContextResponse"
	name="ActivateFederatedInContextResponse"/>
<fault message="tns:AtriumFault" name="AtriumFault"/>
</operation>

WSDL messages

<message name="ActivateFederatedInContextRequest">
	<part element="types:ActivateFederatedInContext" name="inargs"/>
</message>
<message name="ActivateFederatedInContextResponse">
	<part element="types:ActivateFederatedInContextOutput" 	
		name="outargs"/>
</message>
<message name="AtriumFault">
	<part element="common:AtriumFault" name="errargs"/>
</message>

XSD schema

<element name="ActivateFederatedInContext">
	<complexType>
		<sequence>
			<element name="loginInfo"
				type="common:LoginInfo" nillable="true" />
			<element name="classNameId"
				type="common:ClassNameId" />
			<element name="datasetId" type="string" />
			<element name="instanceId" type="string" />
			<element name="federatedInstanceId" type="string" />
			<element name="activateOption"
				type="tns:FederatedActivationOption" />
			<element name="extensions"
				type="common:ExtensionList" nillable="true" />
		</sequence>
	</complexType>
</element>
<element name="ActivateFederatedInContextOutput">
	<complexType>
		<sequence>
			<element name="federatedActivateInfo"
				type="tns:FederatedActivateInfo" />
			<element name="status"
				type="common:StatusList" />
			<element name="extensions"
				type="common:ExtensionList" nillable="true" />
		</sequence>
	</complexType>
</element>
<element name="AtriumFault">
	<complexType>
		<choice>
			<element name="serviceFault"
				type="tns:AtriumServiceFault" />
			<element name="backendFault"
				type="tns:AtriumBackendFault" />
		</choice>
	</complexType>
</element>

Input arguments

loginInfo

User ID, passwords, domain and other information necessary to log on to the application. See LoginInfo.

classNameId

The name of the class. It is a two-part structure that contains the namespace name and the class name. See ClassNameId.

datasetId

The unique identifier for the dataset.

instanceId

The unique identifier.

federatedInstanceId

The unique identifier for the federated instance.

activateOption

See FederatedActivationOption.

extensions

A list of extension types for the operation.

 

Return value

federatedActivateInfo

Holds the federated instance data activation information that is retrieved.

status

A list of zero or more notes, warnings, or errors generated from a call of this operation.

extensions

A list of extension types for the operation.

 

Fault message

Fault message

See Fault message.

Was this page helpful? Yes No Submitting... Thank you

Comments