 |
|
| Model Usage |
Usage Scenario: Creating a Prototype
| Purpose |
This usage scenario describes how to define a prototype. The example focuses on creating a SAS/CONNECT connection prototype. An XML representation of the prototype is included to show how to define Prototype objects and their properties.
| Requirements |
This usage scenario assumes that the user has a general understanding of the Property Submodel and the Software Deployment Submodel of the SAS Metadata Model.
| Description of a Prototype |
A prototype is a template used for creating other metadata objects or a set of metadata objects that represents a concept. The prototype includes all possible valid options or properties that can be used to describe the metadata object that is represented by the prototype. The prototype can then be used to drive a user interface that will help a user create metadata.
Understanding the Prototyping Objects
The primary metadata type in a prototype is the Prototype metadata type. Prototype contains a MetadataType= attribute that stores the name of the metadata type described by the prototype (in this case, a SASClientConnection object). Prototype has a PrototypeProperties association to other objects that define the attributes and associations for the object.
Prototype references AttributeProperty metadata objects to describe the settings of attributes of a metadata object that is created with a template. The AttributeProperty object's Name= attribute is the display name or label used to present this attribute to a user in the user interface. The PropertyName= attribute is the name used by a software program to access the attribute, which is the name of the attribute as defined in the SAS Metadata Model. AttributeProperty has an OwningPrototype association to the Prototype for which it is defined and an OwningType association to a PropertyType metadata object that defines the attribute's format (for example, string, Boolean, file, string array, integer).
Prototype references AssociationProperty metadata objects to describe the associations of a metadata object that is created with a template. The AssociationProperty object's Name= attribute is the display name or label used to present this association to a user in the user interface. The AssociationName= attribute is the name of the association as defined in the SAS Metadata Model. AssociationProperty has an OwningPrototype association to the Prototype for which it is defined, and an AssociatedPrototypes association to other Prototype objects that provide additional information for defining the object.
AttributeProperty and AssociationProperty are subtypes of the PrototypeProperty abstract metadata type. PrototypeProperty defines the following useful associations for managing prototype properties:
- AssociatedPropertyGroup - references a PropertyGroup object that groups the PrototypeProperty subtypes in a way that is useful for a GUI. For example, a PropertyGroup might group AttributeProperty or AssociationProperty objects that are presented on the same page or tab of the GUI.
- PrimaryPropertyGroup - references Property objects that store additional information that needs to be defined about an object, but is not included in the attributes or associations defined for the metadata type in the SAS Metadata Model.
- StoredConfiguration - references a TextStore object or other container object that stores configuration information.
- Customizers - references a metadata object representing a program that can be used to customize or edit a value.
Objects created by using a prototype can maintain an association to the Prototype object that was used to create them with the UsingPackages association.
| Creating a Prototype |
Figure 1 shows the basic metadata objects that define a prototype for a SAS/CONNECT connection. It includes two Prototype objects. A Prototype object named SAS/CONNECT Server has a PrototypeProperties association (numbered 1 in Figure 1) to an AttributeProperty object named ClassIdentifier, and to an AssociationProperty object named SourceConnections. AssociationProperty has an AssociatedPrototypes association (numbered 2) to a Prototype object named SAS/CONNECT Connection.
A SAS/CONNECT server must have a class identifier and source connection defined as properties. The ClassIdentifier= attribute identifies the type of server. The ClassIdentifier for a SAS/CONNECT server is 028e4060-d545-11d5-880d-aa0004006d06. Because there is one valid value, the AttributeProperty object's IsUpdateable= attribute is set to 0 (False) and the value is stored in the DefaultValue= attribute. The SourceConnections association lists the connection objects that describe how to connect to this deployed component. For a SAS/CONNECT server, the source connection is a SAS/CONNECT connection.
![[The metadata objects that define a SAS/CONNECT connection prototype.]](images/prototypefig1.gif)
Figure 1. The metadata objects that define a SAS/CONNECT connection prototype.
| Defining PropertyGroup Objects |
Prototype uses property objects to store additional information about the object that needs to be defined, but is not included in the attributes or associations defined by the SAS Metadata Model. If a Prototype requires Property objects, then it should have a top-level PropertyGroup object associated to it with the PrimaryPropertyGroup association. Then, you define PropertyGroup objects to logically group AttributeProperty, AssociationProperty, and Property objects.
A SAS/CONNECT connection supports several categories of connection properties. Figure 2 shows the PropertyGroup objects that are defined to represent categories and to associate them with the Prototype object. The SAS/CONNECT Connection Prototype object has a PrimaryPropertyGroup association (numbered 1 in Figure 2) to a PropertyGroup object named Connection Information. The Connection Information PropertyGroup object has a SubPropertyGroups association (numbered 2) to two PropertyGroup objects, named SIGNON Types and Advanced Options. The SIGNON Types PropertyGroup has a SubPropertyGroups association to a PropertyGroup object named Scriptless.
![[The metadata objectsthat are needed for grouping properties.]](images/prototypefig2.gif)
| Populating the PropertyGroup Objects |
Figure 3 shows the relationships between the AttributeProperty objects, Property objects, and PropertyGroup objects. When used as part of a prototype definition, a Property object must be associated with only one PropertyGroup. All subtypes of the AbstractProperty metadata type (AttributeProperty, AssociationProperty, and Property) can be associated with the GroupedProperties association (numbered 1 in Figure 3). AttributeProperty objects are defined to represent the CommunicationProtocol=, ApplicationProtocol=, RemoteAddress=, and Service= attributes of the SAS/CONNECT connection, and are associated to the primary Connection Information PropertyGroup object. An AssociationProperty object is defined to represent the AuthenticationDomain association for the SAS/CONNECT connection. Property objects that represent additional input fields are associated with their PropertyGroup objects. This figure shows only Property objects defined for the SIGNON Types and Scriptless PropertyGroup objects. It does not show Property objects for the Advanced Options PropertyGroup object.
![[Relationship between the Subtypes of AbstractProperty Objects and PropertyGroup Objects]](images/prototypefig3.gif)
| XML for Creating a Prototype |
The following XML request can be used to create a prototype for a SAS/CONNECT connection. It is the actual prototype used by SAS Management Console to help a user create a metadata definition for a SAS/CONNECT server. In addition to creating a Prototype object representing a SAS/CONNECT connection, it creates Prototype objects for the SAS/CONNECT server and an AuthenticationDomain. It begins by defining the PropertyType objects that are needed by the ApplicationProperty and Property objects, and then defines the PropertyGroup objects, ApplicationProperty objects, Property objects, and Prototype objects.
<AddMetadata> <Metadata> <PropertyType Id="$String" Name="String" SQLType="12"/> <PropertyType Id="$Boolean" Name="Boolean" SQLType="-7"/> <PropertyType Id="$Integer" Name="Integer" SQLType="4"/> <PropertyType Id="$File" Name="File" SQLType="12"/> <PropertyType Id="$StringArray" Name="String Array" SQLType="2003"> <ElementType> <PropertyType ObjRef="$String"/> </ElementType> </PropertyType> <PropertyType Id="$AuthenticationTypes" Name="AuthenticationTypes" SqlType="12"> <StoredConfiguration> <TextStore Name="Enumeration of Authentication Types" TextRole="config" TextType="xml" StoredText="<Configuration> <Enumeration> <Value name="user/password"/> <Value name="none"/> <Value name="password"/> <Value name="certificate"/> </Enumeration> </Configuration>"/> </StoredConfiguration> </PropertyType> <PropertyType Id="$EncryptionKeySizes" Name="EncryptionKeySizes" SqlType="12"> <StoredConfiguration> <TextStore Name="Enumeration of Encryption Key Sizes" TextRole="config" TextType="xml" StoredText="<Configuration> <Enumeration> <Value name="0"/> <Value name="40"/> <Value name="128"/> </Enumeration> </Configuration>"/> </StoredConfiguration> </PropertyType> <PropertyType Id="$CommunicationProtocols" Name="CommunicationProtocols" SqlType="12"> <ElementType> <PropertyType ObjRef="$String"/> </ElementType> <StoredConfiguration> <TextStore Name="Communication Protocols Enumeration" TextRole="config" TextType="xml" StoredText="<Configuration> <Enumeration> <Value name="TCP"/> <Value name="APPC"/> <Value name="XMS"/> </Enumeration> </Configuration>"/> </StoredConfiguration> </PropertyType> <Prototype Id="$CONNSASConn" Name="SAS/CONNECT Connection" MetadataType="SASClientConnection"> <PrimaryPropertyGroup> <PropertyGroup Id="$ConnectionInformation" Name="Connection Information"> <SubpropertyGroups> <PropertyGroup Id="$SignonInformation" Name="SIGNON Types" Desc="Select one of the following types of signon." Minimum="1" Maximum="1" > <SubpropertyGroups> <PropertyGroup Id="$Scriptless" Name="Scriptless" Desc="" Minimum="1" Maximum="1"/> </SubpropertyGroups> </PropertyGroup> <PropertyGroup Id="$AdvancedOptions" Name="Advanced Options" Desc="" /> </SubpropertyGroups> </PropertyGroup> </PrimaryPropertyGroup> <PrototypeProperties> <AttributeProperty Name="Communication Protocol" PropertyName="CommunicationProtocol" IsExpert="0" IsRequired="1" IsUpdateable="1" IsVisible="1" DefaultValue="TCP"> <OwningType> <PropertyType ObjRef="$CommunicationProtocols"/> </OwningType> <OwningPrototype> <Prototype ObjRef="$CONNSASConn"/> </OwningPrototype> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$ConnectionInformation"/> </AssociatedPropertyGroup> </AttributeProperty> <AttributeProperty Name="Application Protocol" PropertyName="ApplicationProtocol" IsExpert="0" IsRequired="1" IsUpdateable="0" IsVisible="0" DefaultValue="CONNECT"> <OwningType> <PropertyType ObjRef="$String"/> </OwningType> <OwningPrototype> <Prototype ObjRef="$CONNSASConn"/> </OwningPrototype> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$ConnectionInformation"/> </AssociatedPropertyGroup> </AttributeProperty> <AssociationProperty Name="Authentication Domain" AssociationName="Domain" PartnerName="Connections" MetadataType="AuthenticationDomain" IsExpert="0" IsVisible="1" IsUpdateable="1" Minimum="" Maximum="1"> <StoredConfiguration> <TextStore Name="Authentication Domains" TextRole="config" TextType="xml" StoredText="<Configuration> <MetadataRequest> <GetMetadataObjects> <Reposid>_ReposID_</Reposid> <Type>AuthenticationDomain</Type> <NS>SAS</NS> <Flags>264</Flags> <Options></Options> </GetMetadataObjects> </MetadataRequest> <ClassParameters> <Parm Name="_ParentComponent_"/> <Parm Name="_ObjectStore_Persist_"/> <Parm Name="_ReposID_"/> <Parm Name="_Prototype_"/> <Parm Name="New Authentication Domain"/> </ClassParameters> </Configuration>"/> </StoredConfiguration> <Customizers> <ConfiguredComponent Name="PrototypePropertiesDialog Java Class" ClassIdentifier="com.sas.workspace.visuals. PrototypePropertiesDialog"/> </Customizers> <AssociatedPrototypes> <Prototype ObjRef="$CONNSASConn"/> <Prototype ObjRef="$AuthDomain"/> </AssociatedPrototypes> <OwningPrototype> <Prototype ObjRef="$CONNSASConn"/> </OwningPrototype> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$ConnectionInformation"/> </AssociatedPropertyGroup> </AssociationProperty> <AttributeProperty Name="Remote Host" PropertyName="RemoteAddress" IsExpert="0" IsRequired="1" IsUpdateable="1" IsVisible="1" DefaultValue=""> <OwningType> <PropertyType ObjRef="$String"/> </OwningType> <OwningPrototype> <Prototype ObjRef="$CONNSASConn"/> </OwningPrototype> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$ConnectionInformation"/> </AssociatedPropertyGroup> </AttributeProperty> <AttributeProperty Name="Service/Port" PropertyName="Service" IsExpert="0" IsRequired="0" IsUpdateable="1" IsVisible="1" DefaultValue=""> <OwningType> <PropertyType ObjRef="$String"/> </OwningType> <OwningPrototype> <Prototype ObjRef="$CONNSASConn" /> </OwningPrototype> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$ConnectionInformation"/> </AssociatedPropertyGroup> </AttributeProperty> </PrototypeProperties> <Properties> <Property Name="Script" PropertyName="Script" IsExpert="0" IsRequired="1" IsUpdateable="1" IsVisible="1" DefaultValue=""> <OwningType> <PropertyType ObjRef="$File"/> </OwningType> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$SignonInformation"/> </AssociatedPropertyGroup> </Property> <Property Name="Prompt for Userid/Password" PropertyName="Prompt" IsExpert="0" IsRequired="1" IsUpdateable="1" IsVisible="1" DefaultValue="0"> <OwningType> <PropertyType ObjRef="$Boolean"/> </OwningType> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$Scriptless"/> </AssociatedPropertyGroup> </Property> <Property Name="No Userid/Password" PropertyName="NoPrompt" IsExpert="0" IsRequired="1" IsUpdateable="1" IsVisible="1" DefaultValue="1"> <OwningType> <PropertyType ObjRef="$Boolean"/> </OwningType> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$Scriptless"/> </AssociatedPropertyGroup> </Property> <Property Name="SAS Command" PropertyName="SASCMD" IsExpert="0" IsRequired="1" IsUpdateable="1" IsVisible="1" DefaultValue=""> <OwningType> <PropertyType ObjRef="$String"/> </OwningType> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$SignonInformation"/> </AssociatedPropertyGroup> </Property> <Property Name="Remote Session Macvar" PropertyName="macvar" IsExpert="1" IsRequired="0" IsUpdateable="1" IsVisible="1" DefaultValue=""> <OwningType> <PropertyType ObjRef="$String"/> </OwningType> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$AdvancedOptions"/> </AssociatedPropertyGroup> </Property> <Property Name="Execute Remote Submits Synchronously" PropertyName="ConnectWait" IsExpert="1" IsRequired="0" IsUpdateable="1" IsVisible="1" DefaultValue="1"> <OwningType> <PropertyType ObjRef="$Boolean"/> </OwningType> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$AdvancedOptions"/> </AssociatedPropertyGroup> </Property> <Property Name="Display Status Window" PropertyName="ConnectStatus" IsExpert="1" IsRequired="0" IsUpdateable="1" IsVisible="1" DefaultValue="1"> <OwningType> <PropertyType ObjRef="$Boolean"/> </OwningType> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$AdvancedOptions"/> </AssociatedPropertyGroup> </Property> <Property Name="Transmission Buffer Size" PropertyName="Tbufsize" IsExpert="1" IsRequired="0" IsUpdateable="1" IsVisible="1" DefaultValue=""> <OwningType> <PropertyType ObjRef="$String"/> </OwningType> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$AdvancedOptions"/> </AssociatedPropertyGroup> </Property> <Property Name="Requires Encryption" PropertyName="Encryption" IsExpert="1" IsRequired="0" IsUpdateable="1" IsVisible="1" DefaultValue="0"> <OwningType> <PropertyType ObjRef="$Boolean"/> </OwningType> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$AdvancedOptions"/> </AssociatedPropertyGroup> </Property> <Property Name="Encryption Algorithm Names" PropertyName="EncryptionAlgorithms" IsExpert="1" IsRequired="0" IsUpdateable="1" IsVisible="1" DefaultValue=""> <OwningType> <PropertyType ObjRef="$String"/> </OwningType> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$AdvancedOptions"/> </AssociatedPropertyGroup> </Property> <Property Name="Encryption Algorithm Key Size" PropertyName="EncryptionKeySize" IsExpert="1" IsRequired="0" IsUpdateable="1" IsVisible="1" DefaultValue=""> <OwningType> <PropertyType ObjRef="$EncryptionKeySizes"/> </OwningType> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$AdvancedOptions"/> </AssociatedPropertyGroup> </Property> </Properties> </Prototype> <Prototype Id="$CONNDC" Name="SAS/CONNECT Server" Desc="This server defines a SAS/CONNECT Server for SAS 9." MetadataType="ServerComponent"> <Extensions> <Extension Name="UITreeCategory" Value="SAS Servers.SAS Application Server Components" ExtensionType="VARCHAR" /> </Extensions> <PrimaryPropertyGroup> <PropertyGroup Id="$CONNECTServer" Name="CONNECT Server Properties"/> </PrimaryPropertyGroup> <PrototypeProperties> <AssociationProperty Name="" AssociationName="SourceConnections" PartnerName="Source" Minimum="1" Maximum="1" MetadataType="ServerComponent"> <AssociatedPrototypes> <Prototype ObjRef="$CONNSASConn" /> </AssociatedPrototypes> <OwningPrototype> <Prototype ObjRef="$CONNDC" /> </OwningPrototype> </AssociationProperty> <AttributeProperty Name="ClassIdentifier" PropertyName="ClassIdentifier" IsExpert="0" IsRequired="1" IsUpdateable="0" IsVisible="0" DefaultValue="028e4060-d545-11d5-880d-aa0004006d06"> <OwningType> <PropertyType ObjRef="$Integer"/> </OwningType> <OwningPrototype> <Prototype ObjRef="$CONNDC"/> </OwningPrototype> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$CONNECTServer"/> </AssociatedPropertyGroup> </AttributeProperty> <AttributeProperty Name="Major Version Number" PropertyName="Major" IsExpert="0" IsRequired="1" IsUpdateable="1" IsVisible="1" DefaultValue="9"> <OwningType> <PropertyType ObjRef="$Integer"/> </OwningType> <OwningPrototype> <Prototype ObjRef="$CONNDC"/> </OwningPrototype> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$CONNECTServer"/> </AssociatedPropertyGroup> </AttributeProperty> <AttributeProperty Name="Minor Version Number" PropertyName="Minor" IsExpert="0" IsRequired="1" IsUpdateable="1" IsVisible="1" DefaultValue="0"> <OwningType> <PropertyType ObjRef="$Integer"/> </OwningType> <OwningPrototype> <Prototype ObjRef="$CONNDC"/> </OwningPrototype> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$CONNECTServer"/> </AssociatedPropertyGroup> </AttributeProperty> <AttributeProperty Name="Product Name" PropertyName="ProductName" IsExpert="0" IsRequired="1" IsUpdateable="0" IsVisible="0" DefaultValue="SAS/CONNECT"> <OwningType> <PropertyType ObjRef="$String"/> </OwningType> <OwningPrototype> <Prototype ObjRef="$CONNDC"/> </OwningPrototype> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$CONNECTServer"/> </AssociatedPropertyGroup> </AttributeProperty> <AttributeProperty Name="Software Version" PropertyName="SoftwareVersion" IsExpert="0" IsRequired="1" IsUpdateable="1" IsVisible="1" DefaultValue="9.0"> <OwningType> <PropertyType ObjRef="$String"/> </OwningType> <OwningPrototype> <Prototype ObjRef="$CONNDC"/> </OwningPrototype> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$CONNECTServer"/> </AssociatedPropertyGroup> </AttributeProperty> <AttributeProperty Name="Vendor" PropertyName="Vendor" IsExpert="0" IsRequired="1" IsUpdateable="1" IsVisible="1" DefaultValue="SAS Institute"> <OwningType> <PropertyType ObjRef="$String"/> </OwningType> <OwningPrototype> <Prototype ObjRef="$CONNDC"/> </OwningPrototype> <AssociatedPropertyGroup> <PropertyGroup ObjRef="$CONNECTServer"/> </AssociatedPropertyGroup> </AttributeProperty> </PrototypeProperties> </Prototype> <Prototype Id="$AuthDomain" Name="Authentication Domain" MetadataType="AuthenticationDomain"> <PrimaryPropertyGroup> <PropertyGroup Name="Primary Group" > <GroupedProperties> <AttributeProperty Name="Name" PropertyName="Name" IsExpert="0" IsRequired="1" IsUpdateable="1" IsVisible="1" DefaultValue=""> <OwningType> <PropertyType ObjRef="$String"/> </OwningType> <OwningPrototype> <Prototype ObjRef="$AuthDomain" /> </OwningPrototype> </AttributeProperty> <AttributeProperty Name="Description" PropertyName="Desc" IsExpert="0" IsRequired="0" IsUpdateable="1" IsVisible="1" DefaultValue=""> <OwningType> <PropertyType ObjRef="$String"/> </OwningType> <OwningPrototype> <Prototype ObjRef="$AuthDomain" /> </OwningPrototype> </AttributeProperty> </GroupedProperties> </PropertyGroup> </PrimaryPropertyGroup> </Prototype> </Metadata> <Reposid>_ReposID_</Reposid> <Ns>SAS</Ns> <Flags>268435456</Flags> <Options/> </AddMetadata>
|
|
Copyright © 2009 by SAS Institute Inc., Cary, NC, USA. All rights reserved.