CoreRMO::Find Candidates By Mapping

Finds candidates (resource instances, resource groups, consumer instances, and consumer groups) based on their mapping relationship with other instances or groups and adds them to the specified candidate set. Used by Microsoft. Provisioning Framework (MPF).

XML Input Schema

The following code fragment shows the format for sending data to this procedure. For more information on individual elements and attributes, see the Elements and Attributes table.

<executeData>1..1
  <candidates>1..1
	<targetSet>1..1</targetSet>
	<rank>0..1</rank>
	<relatedFromSet>0..1</relatedFromSet>
	<relatedToSet>0..1</relatedToSet>
	<relationship>0..1</relationship>
	<sourceCategory>0..1</sourceCategory>
	<targetCategory>0..1</targetCategory>
  </candidates>
</executeData>

XML Output Schema

Find Candidates By Mapping does not return data.

Elements and Attributes

The following table describes the XML elements and attributes. Unless otherwise indicated, the data type is string.

Element Description, relationships, and attributes
candidates Description:
Encapsulates data needed to interact with a candidate set.

Parent:
executeData

Children:
rank (minOccurs="0" maxOccurs="1")
relatedFromSet (minOccurs="0" maxOccurs="1")
relatedToSet (minOccurs="0" maxOccurs="1")
relationship (minOccurs="0" maxOccurs="1")
sourceCategory (minOccurs="0" maxOccurs="1")
targetCategory (minOccurs="0" maxOccurs="1")
targetSet (minOccurs="1" maxOccurs="1")
executeData Description:
 Encapsulates the procedure's input data.

Child:
candidates (minOccurs="1" maxOccurs="1")
rank Description:
Integer that specifies the rank to assign to the instances or groups when they are added to the candidate set. If not specified, the default value is null.

Parent:
candidates

relatedFromSet Description:
Set of groups or instances in the "from" side of the relationship. If both relatedFromSet and relatedToSet nodes are specified, the updated candidate set shows the "from" candidates first, followed by the "to" candidates. If neither is specified, no candidates is added.

Parent:
candidates

relatedToSet Description:
Set of groups or instances in the "to" side of the relationship. If both relatedFromSet and relatedToSet nodes are specified, the updated candidate set consists of the union of the "from" candidates and "to" candidates. If neither is specified, no candidates are added.

Parent:
candidates

relationship Description:
Name of the relationship that exists between the source and target instances or groups. Can be used to narrow the result set down to those elements that have a given relationship to each other. If not specified, all relationships are added.

Parent:
candidates

sourceCategory Description:
Category of the source groups or instances to consider: resourceInstance, resourceGroup, consumerInstance, or consumerGroup. If not specified, all instances and groups in either or both the "from" set or the "to" set are added.

Parent:
candidates

targetCategory Description:
Category of the target groups or instances to consider: resourceInstance, resourceGroup, consumerInstance, or consumerGroup. If not specified, the instances and groups in the opposite end of the relationship are added.

Parent:
candidates

targetSet Description:
Name of the candidate set to add the instances or groups to.

Parent:
candidates

Remarks

Instances or groups of interest are found and added by specifying:

For example, suppose a mapping relationship called "allocation" exists from resourceInstance R to consumerInstance C. ResourceSet is a candidate set containing R, and ConsumerSet is a candidate set containing C. To find C and add it to a candidate set called ResultSet, you would pass the following XML.

<targetSet>ResultSet</targetSet>
<relatedFromSet>ResourceSet</relatedFromSet>
<relationship>allocation</relationship>
<sourceCategory>resourceInstance</sourceCategory>
<targetCategory>consumerInstance</targetCategory>

To find R and add it to a candidate set called ResultSet, the XML would be:

<targetSet>ResultSet</targetSet>
<relatedToSet>ConsumerSet</relatedToSet>
<relationship>allocation</relationship>
<sourceCategory>consumerInstance</sourceCategory>
<targetCategory>resourceInstance</targetCategory>

See Also

CoreRMO Provider, Discard Candidates By Mapping, Keep Candidates By Mapping, Resource Manager

Up Top of Page
) 1999-2002 Microsoft Corporation. All rights reserved.