AgreementConfiguration Element
 |
For security labels to work, you do not need to enable agreements. If you are not planning to use agreements, you do not need to include this element.
|
The AgreementConfiguration element and subelements are specified in the following manner, using sample information:
<AgreementConfiguration enabled="true">
<AgreementManagersGroup>
<groupUfid>cn=Agreement Managers,ou=people,
cn=AdministrativeLdap,cn=Windchill_9.1,o=ptc
|Ldap.ptcnet.ptc.com|Ldap.ptcnet.ptc.com</groupUfid>
</AgreementManagersGroup>
<AgreementLifecycleState>
<lifecycleState>APPROVED</lifecycleState>
</AgreementLifecycleState>
<AgreementCabinetDomain>
<domainPath>/Default</domainPath>
</AgreementCabinetDomain>
<ContextBasedAgreementType>
<logicalTypeId>com.ptc.security.ContextBasedAgreement</logicalTypeId>
</ContextBasedAgreementType>
<SelectAuthorizedSecurityLabelValuesStep value="show"/>
<AuthorizedSecurityLabelValuesDefault value="all"/>
</AgreementConfiguration>
<AgreementManagersGroup>
<groupUfid>cn=Agreement Managers,ou=people,
cn=AdministrativeLdap,cn=Windchill_9.1,o=ptc
|Ldap.ptcnet.ptc.com|Ldap.ptcnet.ptc.com</groupUfid>
</AgreementManagersGroup>
<AgreementLifecycleState>
<lifecycleState>APPROVED</lifecycleState>
</AgreementLifecycleState>
<AgreementCabinetDomain>
<domainPath>/Default</domainPath>
</AgreementCabinetDomain>
<ContextBasedAgreementType>
<logicalTypeId>com.ptc.security.ContextBasedAgreement</logicalTypeId>
</ContextBasedAgreementType>
<SelectAuthorizedSecurityLabelValuesStep value="show"/>
<AuthorizedSecurityLabelValuesDefault value="all"/>
</AgreementConfiguration>
To enable agreements, the value of the enabled attribute on the AgreementConfiguration element must be set to true and at least one security label value must have an agreementType subelement.
The AgreementManagersGroup element represents the Windchill group that is granted access to see the agreement user interface and to manage agreements in the Windchill solution. This group is represented by a UFID (Unique Federation Identifier). For information on how to specify a UFID, see Specifying a UFID.
The AgreementLifecycleState element specifies the life cycle state in which the agreement is considered approved and can be active. The value for the lifecycleState element must be one of the keys defined in the life cycle state resource information file (<Windchill>/src/wt/lifecycle/StateRB.rbInfo), for example, APPROVED.
For more information about setting the life cycle template for agreements, see Agreement Life Cycle.
For more information on changing the life cycle state, see Customize Modeled Enumerations Utility.
The AgreementCabinetDomain element specifies the domain assigned to agreements in each context where agreements are stored. The domain is used to determine the default access control policies for the cabinet and its contents. The path is relative to the context in which the agreement cabinet is created. This domain can be the /Default domain for the context, or a custom domain configured at your site. If no domain is specified, the agreements cabinet resides in the /Default domain.
For information on creating a custom domain, see Creating Custom Domains for Agreements.
The ContextBasedAgreementType element specifies the agreement type for context-based agreements. Any agreement created with the type specified in the element, or a subtype of this type, is treated as a context-based agreement. The ContextBasedAgreementType element is represented by the logical form of the object type. The logical form is the internal name of the type as shown in the Type and Attribute Management utility. The ContextBasedAgreementType element is not required if your site only wants to use standard agreements.
For more information, see Agreement Type and SubTypes.
The SelectAuthorizedSecurityLabelsStep element enables the Select Authorized Security Label Values step on the New Agreement and Edit Agreement windows. To enable the step, the value of the element must be set to show. To disable the step, do not specify the SelectAuthorizedSecurityLabelsStep, or set the value to hide. If the step is enabled, the Authorize drop-down list will display with a default selection of All Values. To change the default selection for the drop-down list, specify the AuthorizedSecurityLabelValuesDefault subelement with one of the following values:
• all: Sets the default selection to All Applicable Values for standard security labels and to All Values for custom security labels. The default selection of All Applicable Values can also be achieved if you do not specify the AuthorizedSecurityLabelValuesDefault element.
• selected: Sets the default selection to Selected Values for standard security labels and to No Values for custom security labels.
• none: Sets the default selection to No Values for standard and custom security labels.
For more information about the Select Authorized Security Label Values step, see Authorized Security Label Values.