Create-Links
The Create-Links webject creates new associations between Windchill objects. The associations are created with the specified attribute values and stored in the Windchill database.
When creating a single object, this webject is typically called with the FROM_OBJECT_REF and TO_OBJECT_REF parameters. When creating multiple objects this webject is typically called with the GROUP_IN parameter.
All objects are created within a transaction. If any object creation fails, then no objects are created.
Syntax
<ie:webject name="Create-Links" type="ACT">
<ie:param name="ACCEPT_LANGUAGE"
data="$(@SERVER[]accept_language[])"/>
<ie:param name="ATTRIBUTE" data="attribute_name"/>
<ie:param name="AUTHORIZATION"
data="$(@SERVER[]authorization[0])"/>
<ie:param name="CONNECTION_ATTEMPTS" data="attempts"/>
<ie:param name="CONNECTION_ATTEMPT_INTERVAL" data="interval"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="DESCRIPTOR" data="attribute_name"/>
<ie:param name="FIELD" data="name=value"/>
<ie:param name="FORMAT" data="[TRUE | FALSE]"/>
<ie:param name="FROM_OBJECT_REF" data="ufid"/>
<ie:param name="GROUP_IN" data="group_in"/>
<ie:param name="GROUP_OUT" data="group_out"/>
<ie:param name="INCLUDE_ARGS" data="[TRUE | FALSE]"/>
<ie:param name="INCLUDE_CONSTRAINTS" data="[TRUE | FALSE]"/>
<ie:param name="INCLUDE_DESCRIPTORS" data="[TRUE | FALSE]"/>
<ie:param name="INSTANCE" data="appl_name"/>
<ie:param name="NEXT_OP" data="operation_name"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="REFERENCE_DELIMITER" data="^" />
<ie:param name="REFERENCE_EXCEPTIONS" data="[TRUE | FALSE]"/>
<ie:param name="REFERENCE_OUTPUT_DELIMITER" data="^" />
<ie:param name="SESSION_ID" data="$(session[]session_id[])"/>
<ie:param name="TO_OBJECT_REF" data="ufid"/>
<ie:param name="TYPE" data="type_name"/>
<ie:param name="UNFORMATTED" data="dataType" />
</ie:webject>
<ie:param name="ACCEPT_LANGUAGE"
data="$(@SERVER[]accept_language[])"/>
<ie:param name="ATTRIBUTE" data="attribute_name"/>
<ie:param name="AUTHORIZATION"
data="$(@SERVER[]authorization[0])"/>
<ie:param name="CONNECTION_ATTEMPTS" data="attempts"/>
<ie:param name="CONNECTION_ATTEMPT_INTERVAL" data="interval"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="DESCRIPTOR" data="attribute_name"/>
<ie:param name="FIELD" data="name=value"/>
<ie:param name="FORMAT" data="[TRUE | FALSE]"/>
<ie:param name="FROM_OBJECT_REF" data="ufid"/>
<ie:param name="GROUP_IN" data="group_in"/>
<ie:param name="GROUP_OUT" data="group_out"/>
<ie:param name="INCLUDE_ARGS" data="[TRUE | FALSE]"/>
<ie:param name="INCLUDE_CONSTRAINTS" data="[TRUE | FALSE]"/>
<ie:param name="INCLUDE_DESCRIPTORS" data="[TRUE | FALSE]"/>
<ie:param name="INSTANCE" data="appl_name"/>
<ie:param name="NEXT_OP" data="operation_name"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="REFERENCE_DELIMITER" data="^" />
<ie:param name="REFERENCE_EXCEPTIONS" data="[TRUE | FALSE]"/>
<ie:param name="REFERENCE_OUTPUT_DELIMITER" data="^" />
<ie:param name="SESSION_ID" data="$(session[]session_id[])"/>
<ie:param name="TO_OBJECT_REF" data="ufid"/>
<ie:param name="TYPE" data="type_name"/>
<ie:param name="UNFORMATTED" data="dataType" />
</ie:webject>
Parameters
|
Required
|
Interdependent
|
Optional
|
|---|---|---|
|
FROM_OBJECT_REF
|
AUTHORIZATION
|
ACCEPT_LANGUAGE
|
|
INSTANCE
|
DBUSER
|
ATTRIBUTE
|
|
TYPE
|
GROUP_IN
|
CONNECTION_ATTEMPTS
|
|
INCLUDE_ARGS
|
CONNECTION_ATTEMPT_INTERVAL
|
|
|
INCLUDE_CONSTRAINTS
|
FIELD
|
|
|
INCLUDE_DESCRIPTORS
|
FORMAT
|
|
|
NEXT_OP
|
GROUP_OUT
|
|
|
PASSWD
|
REFERENCE_DELIMITER
|
|
|
REFERENCE_EXCEPTIONS
|
REFERENCE_OUTPUT_DELIMITER
|
|
|
TO_OBJECT_REF
|
SESSION_ID
|
|
|
UNFORMATTED
|
 |
If a parameter is listed in the table but is not defined below, then it has a common parameter definition. For descriptions of those parameters, see Common Webject Parameters section in Adapter Webjects Overview.
|
FIELD
An attribute and associated value to be included in the requested operation. The attribute and associated value are separated by an equals sign. For example:
<ie:param name="FIELD" data="source=wt.part.Source.make"/>
The attribute and value are dependent on the object and operation being performed. This parameter is optional. This parameter can have multiple values.
FROM_OBJECT_REF
The Unique Federation Identifier (UFID) of an existing object that serves as the primary object of the association (role A). The working copy of the object must be specified, and the object must already be checked out. This parameter is required.
GROUP_IN
Specifies a group containing objects. For each element of the group that contains an object ID (OBID) attribute, a new association is created.
• The primary object of each association is the object specified by FROM_OBJECT_REF.
• Secondary objects are the objects specified by the OBID attribute value of each element in the group specified by GROUP_IN.
Thus, an association is created between the object specified by FROM_OBJECT_REF and each object specified in GROUP_IN.
If GROUP_IN is not specified, then the TO_OBJECT_REF parameter must be specified.
GROUP_OUT
The name of the output group containing the results. If this parameter is omitted, then the name of the output group is constructed by appending the string “-Output” to the webject name. This parameter is optional.
TO_OBJECT_REF
Specifies the UFID of an existing object that serves as the other object of the association.
• The primary objects in each association are the objects specified by the value of FROM_OBJECT_REF. An association is created between the object specified by FROM_OBJECT_REF and each object specified by the TO_OBJECT_REF values.
• If not specified, the GROUP_IN parameter must be specified.
This parameter is multi-valued.
If the UFID of a non-primary object indicates that the object actually resides in a remote information system (and not the local Windchill system), the association is created using a FederatedLink object. In addition, a LightweightProxy object is also created, if necessary, to serve as a local reference to the remote object. The LightweightProxy object is registered as the non-primary role of the association.
TYPE
Specifies the type of link to create. This parameter is required.