 |
|
| SAS Namespace Types |
Root
Overview
This is an abstract type that is the supertype for all of the other metadata types.
Security Inheritance and Enforcement Rules
The following list of associations is used to determine if this object should inherit access controls from another object (inheritance), or if the association is allowed for the object (enforcement). An association will not be created unless the calling user is authorized to update one or both objects involved in the association. For more information about inheritance and enforcement rules, see the SAS Intelligence Platform: Security Administration Guide.
- Trees
Attributes
| Name | Description | Type | Length |
| Id | Object's repository id. | String | 17 |
| Name | A logical identifier for the object. Used for, but not limited to, display. | String | 60 |
| Desc | More detailed documentation for this object. | String | 200 |
| MetadataCreated | Date and time at which the metadata object was created. | Double | |
| MetadataUpdated | Date and time at which the metadata object was last updated. | Double | |
| ChangeState | This attribute is used by Change management. | String | 64 |
| LockedBy | This attribute is used by Change management. | String | 32 |
| SecTransctxt | An ISecAdmin TransactionContext (TC) handle that corresponds to this object. | String | 16 |
| UsageVersion | Usage version is used by an application to indicate the usage pattern of the logical object. | double |
Associations
= indicates the resident side of an association, or where the association is persisted for cross-repository associations. If no resident side is indicated, this association may not cross repository boundaries.
| Name | Cardinality | Description | Associated Types |
| AccessControls Partner: Objects | 0 to * | The access controls for this object. |
AccessControl AccessControlEntry AccessControlTemplate |
| Changes Partner: Objects | 0 to * | The changes that have been made to this object. | Change |
| CustomAssociations Partner: OwningObject | 0 to * | The custom associations related to this owning object. | CustomAssociation |
| Documents Partner: Objects | 0 to * | The documents that are associated with this object. | Document |
| Extensions Partner: OwningObject | 0 to * | The object the extension is associated with. An extension can be associated with any kind of object. | AbstractExtension Extension NumericExtension |
| ExternalIdentities Partner: OwningObject | 0 to * | The external identities for this object in other contexts. | ExternalIdentity |
| Groups Partner: Members | 0 to * | The groups that have this object as a member. |
Group SXLEMap |
| Implementors Partner: ImplementedObjects | 0 to * | The software components that utilize the metadata in this object. | SoftwareComponent ConfiguredComponent DeployedComponent LogicalServer ServerComponent ServerContext ServiceComponent |
| Keywords Partner: Objects | 0 to * | The keywords associated with this object. | Keyword |
| LocalizedAttributes Partner: AssociatedLocalizedObject | 0 to * | The attribute that has localized resources. | Property |
| Notes Partner: Objects | 0 to * | The list of notes associated with the object. | TextStore |
| PrimaryPropertyGroup Partner: AssociatedObject | 0 to 1 | The starting place for a hierarchy of property objects, often used to help drive a UI. | PropertyGroup |
| Prompts Partner: PromptEnabledObject | 0 to * | The prompts or prompt group for this object. | AbstractPrompt Prompt PromptGroup |
| Properties Partner: AssociatedObject | 0 to * | The default properties of this object. | Property |
| PropertySets Partner: OwningObject | 0 to * | Complete set of properties used in a particular context. | PropertySet |
| ReferencedObjects Partner: AssociatedObjects | 0 to * | The object(s) that are associated to the owning object using this custom association. | CustomAssociation |
| ResponsibleParties Partner: Objects | 0 to * | The list of responsibilities that have been assigned for this object. | ResponsibleParty |
| SourceTransformations Partner: TransformationSources | 0 to * | The set of transformations that use this input. | AbstractTransformation AbstractJob ClassifierMap FeatureMap JFJob Job Join MiningResult Select SyncStep Transformation TransformationActivity TransformationStep |
| SpecSourceTransformations Partner: SourceSpecifications | 0 to * | The transformation that uses this specification as a source. | AbstractTransformation AbstractJob ClassifierMap FeatureMap JFJob Job Join MiningResult Select SyncStep Transformation TransformationActivity TransformationStep |
| SpecTargetTransformations Partner: TargetSpecifications | 0 to * | The transformation that uses this specification as a target. | AbstractTransformation AbstractJob ClassifierMap FeatureMap JFJob Job Join MiningResult Select SyncStep Transformation TransformationActivity TransformationStep |
| TargetTransformations Partner: TransformationTargets | 0 to * | The set of transformation activities that create this result. | AbstractTransformation AbstractJob ClassifierMap FeatureMap JFJob Job Join MiningResult Select SyncStep Transformation TransformationActivity TransformationStep |
| Timestamps Partner: Objects | 0 to * | The timestamps associated with this object. | Timestamp |
| Trees Partner: Members | 0 to * | The trees that have this object as a member. | Tree |
| TSObjectNamespace Partner: TSObjects | 0 to 1 | Table server namespace for this object. | TSNamespace |
| UsedByPrototypes Partner: UsingPrototype | 0 to * | The objects that use this object as a prototype. | *ALL TYPES* |
| UsingPrototype Partner: UsedByPrototypes | 0 to 1 | The prototype for this object. This must be a Prototype object, or an object of the SAME metadata type as this object. | *ALL TYPES* |
| Variables Partner: AssociatedObject | 0 to * | The variables associated with this object. | Variable |
Attribute Details
Name
Type: String 60
RequiredThe name is a logical identifier for the object. Used for, but not limited to, display. Because it is often used for display it is subject to being localized. Even though this is a required attribute, in practice it behaves more like a label than a name. Metadata types that require a name that can be relied on for code in applications will typically have an additional name attribute, e.g. PropertyName, TableName, ColumnName.
The following restrictions are currently enforced by InformationService and are proposed as a best practice.
Non-null
60 >= length > 0
May not start or end with a whitespace character
May not contain '/', '\' or control characters
Names may contain any Unicode characters, subject to the restrictions listed above.
Desc
Type: String 200
OptionalThe Desc allows for a brief description of the object. If an object needs more detailed information, refer to Notes or Documents. The desc is subject to localization, which should be taken into account when providing a description.
Id
Type: String 17Id is a 17-character string that is guaranteed to be unique for a given object within a metadata server. It takes the form of A0000001.A0000001 where the first 8 characters represent the repository Id and the second 8 characters represent the object Id. If the object is a repository, the first 8 characters represent the repository manager and will always be equal to A0000001; the second eight characters represent the repository Id.
Ids should never be stored outside of the metadata object and it should not be assumed that a given logical entity will retain the same metadata Id during its lifetime. When updating logical entities in the metadata server, applications often delete and re-create objects in the metadata server. The new objects created will have different metadata Ids than the original. Also, metadata definitions may be exported and deployed to a new metadata server. These, too, will have different metadata ids than the original objects. It is important to note here that the pattern of deleting and recreating objects in the server instead of doing an actual update is discouraged. This pattern creates unnecessary I/O and removes all associations to other objects. The deleting application is often not aware of all associations and will be unable to re-create links that other applications are relying on.
MetadataCreated
Type: DoubleDate and time at which the metadata object was created. Stored as GMT values in SAS date, time, and datetime encoding. To store the creation date of the entity that the metadata describes use the Timestamps association.
For more information, see:
- Storage and Formatting of Date, Time, and Datetime Values
- "Attribute Criteria Component" in "<XMLSELECT search="criteria"/> Syntax" in the SAS Open Metadata Interface: Reference and Usage.
MetadataUpdated
Type: DoubleDate and time at which the metadata object was last updated. Stored as GMT values in SAS date, time, and datetime encoding. To store the modified date of the entity that the metadata describes use the Timestamps association. For more information, see:
- Storage and Formatting of Date, Time, and Datetime Values
- "Attribute Criteria Component" in "<XMLSELECT search="criteria"/> Syntax" in the SAS Open Metadata Interface: Reference and Usage.
ChangeState
Type: String 64Used by the change management facility to store information about an object's modified status. The change management facility is used exclusively by SAS Data Integration Studio.
LockedBy
Type: String 32Indicates whether a source lock is held on the object. When an object is locked, it stores the metadata identifier of the person who locked the object. Otherwise, this attribute is blank. For more information, see "Metadata Locking Options" in the SAS Open Metadata Interface: Reference and Usage.
SecTransctxt
Type: String 16SecTransctxt is a non-persisted attribute that contains the value of an ISecAdmin TransactionContext (TC) handle that references permission settings for a single corresponding metadata object. Supplying the SecTransctxt attribute allows an application to create or update an object and commit its corresponding permission settings when metadata is added or updated. Once the request completes, the handle value passed in SecTransctxt is no longer valid, and the application should no longer reference it or attempt to replay it to the SAS Metadata Server.
UsageVersion
Type: DoubleAll objects that participate in the SAS type dictionary must implement a standard usage version. The usage version is simply a version number persisted with the object and rules for interpreting those version numbers. The usage version determines the level of compatibility between the persisted object and any applications that may access the object. Recommendations for usage versioning may be found at UsageVersion.
Association Details
AccessControls
Cardinality: 0 to *
Partner: Objects
The access controls for this object.
Associated Types:
AccessControl, AccessControlEntry, AccessControlTemplateChanges
Cardinality: 0 to *
Partner: Objects
This association is used by the change management facility to indicate the objects included in a given change. The change management facility is used exclusively by SAS Data Integration Studio.
Associated Types:
ChangeCustomAssociations
Cardinality: 0 to *
Partner: OwningObject
The custom associations related to this owning object.
Associated Types:
CustomAssociationDocuments
Cardinality: 0 to *
Partner: Objects
The documents that are associated with this object.
Associated Types:
DocumentExtensions
Cardinality: 0 to *
Partner: OwningObject
The object the extension is associated with. An extension can be associated with any kind of object.
Associated Types:
AbstractExtension, Extension, NumericExtensionExternalIdentities
Cardinality: 0 to *
Partner: OwningObject
The external identities for this object in other contexts.
Associated Types:
ExternalIdentityGroups
Cardinality: 0 to *
Partner: Members
The groups that have this object as a member.
Associated Types:
Group, SXLEMapImplementors
Cardinality: 0 to *
Partner: ImplementedObjects
The software components that utilize the metadata in this object.
Associated Types:
SoftwareComponent, ConfiguredComponent, DeployedComponent, LogicalServer, ServerComponent, ServerContext, ServiceComponentKeywords
Cardinality: 0 to *
Partner: Objects
The keywords associated with this object.
Associated Types:
KeywordLocalizedAttributes
Cardinality: 0 to *
Partner: AssociatedLocalizedObject
Lists localized attributes that are defined for this object. A localized attribute is modeled with a Property object that has the same Name value as the attribute that it localizes, and has the Role attribute set to "Override".
Associated Types:
PropertyNotes
Cardinality: 0 to *
Partner: Objects
The list of notes associated with the object.
Associated Types:
TextStorePrimaryPropertyGroup
Cardinality: 0 to 1
Partner: AssociatedObject
Any object may have one PrimaryPropertyGroup. PrimaryPropertyGroup is the starting place for a hierarchy of property objects, often used to help drive a UI. The properties contained in this group are not actual values, instead they represent the set of possible values or options for the associated object. For more information, see PropertyGroup.
Associated Types:
PropertyGroupPrompts
Cardinality: 0 to *
Partner: PromptEnabledObject
The prompts or prompt group for this object.
Associated Types:
AbstractPrompt, Prompt, PromptGroupProperties
Cardinality: 0 to *
Partner: AssociatedObject
Lists the default properties for this object. This association should contain a complete set of properties for "default" usage. If there are no default properties, then this association should not be used. Propertie s that are relevant only for a specific context should be grouped using a PropertySet object. For more information, see Property.
The Properties association for SASLibrary and PhysicalTable objects must contain valid LIBNAME statement options.
Associated Types:
PropertyPropertySets
Cardinality: 0 to *
Partner: OwningObject
Any object may have one or more PropertySet objects. A PropertySet contains a complete group of properties used in a particular context. For more information, see PropertySet.
Associated Types:
PropertySetReferencedObjects
Cardinality: 0 to *
Partner: AssociatedObjects
The object(s) that are associated to the owning object using this custom association.
Associated Types:
CustomAssociationResponsibleParties
Cardinality: 0 to *
Partner: Objects
The list of responsibilities that have been assigned for this object. In order to determine the identities who have been assigned to a particular responsibility, the application writer would need to traverse the Persons association.
Associated Types:
ResponsiblePartySourceTransformations
Cardinality: 0 to *
Partner: TransformationSources
The set of transformations that use this input.
Associated Types:
AbstractTransformation, AbstractJob, ClassifierMap, FeatureMap, JFJob, Job, Join, MiningResult , Select, SyncStep, Transformation, TransformationActivity, TransformationStepSpecSourceTransformations
Cardinality: 0 to *
Partner: SourceSpecifications
The transformation that uses this specification as a source.
Associated Types:
AbstractTransformation, AbstractJob, ClassifierMap, FeatureMap, JFJob, Job, Join, MiningResult , Select, SyncStep, Transformation, TransformationActivity, TransformationStepSpecTargetTransformations
Cardinality: 0 to *
Partner: TargetSpecifications
The transformation that uses this specification as a target.
Associated Types:
AbstractTransformation, AbstractJob, ClassifierMap, FeatureMap, JFJob, Job, Join, MiningResult , Select, SyncStep, Transformation, TransformationActivity, TransformationStepTargetTransformations
Cardinality: 0 to *
Partner: TransformationTargets
The set of transformation activities that create this result.
Associated Types:
AbstractTransformation, AbstractJob, ClassifierMap, FeatureMap, JFJob, Job, Join, MiningResult , Select, SyncStep, Transformation, TransformationActivity, TransformationStepTimestamps
Cardinality: 0 to *
Partner: Objects
The timestamps associated with this object.
Associated Types:
TimestampTrees
Cardinality: 0 to *
Partner: Members
The trees that have this object as a member.
Associated Types:
TreeTSObjectNamespace
Cardinality: 0 to 1
Partner: TSObjects
Table server namespace for this object.
Associated Types:
TSNamespaceUsedByPrototypes
Cardinality: 0 to *
Partner: UsingPrototype
The objects that use this object as a prototype.
Associated Types:
*ALL TYPES*
UsingPrototype
Cardinality: 0 to 1
Partner: UsedByPrototypes
The prototype for this object. This must be a Prototype object, or an object of the SAME metadata type as this object.
Associated Types:
*ALL TYPES*
Variables
Cardinality: 0 to *
Partner: AssociatedObject
The variables associated with this object.
Associated Types:
Variable
|
|
Copyright © SAS Institute Inc. All rights reserved.