Types
Entity types
Entity types are structured records consisting of named and typed properties. Entity types contain a key.
Annotation
An element that represents a single annotation.
An annotation applies a term to a model element and defines how to calculate a value for the term application.
Key: ID
OpenType: true
Name | Details |
---|---|
ID |
The ID of the annotation. Type: Edm.String Nullable: false |
Text |
The text of the annotation. Type: Edm.String |
Creator |
The creator of the annotation. Type: Edm.String |
Created |
The date that the annotation was created. Type: Edm.DateTimeOffset |
LastUpdatedBy |
The ID of the element that updated the annotation. Type: Edm.String |
LastUpdated |
The date and time value of the last update of this annotation, with a time zone offset. Type: Edm.DateTimeOffset |
Name | Details |
---|---|
ApplicationContext |
An interface to the collection of configuration information for the annotation. Type: Collection(tm1.ApplicationContextFacetValue) |
DimensionalContext |
An interface to the collection of dimensions for the annotation. Type: Collection(tm1.Member) |
Attachments |
Attached documents that provide details and background. Type: Collection(tm1.Attachment) ContainsTarget: true |
ApplicationContextFacet
The facet of the application context.
Key: Name
Name | Details |
---|---|
Name |
The name of the application context facet. Type: Edm.String Nullable: false |
Name | Details |
---|---|
Values |
The value of the application context facet, see ApplicationContextFacetValue. Type: Collection(tm1.ApplicationContextFacetValue) ContainsTarget: true |
ApplicationContextFacetValue
A value for a facet of the application context.
Key: Value
Name | Details |
---|---|
Value |
The application context facet value. Type: Edm.String Nullable: false |
Name | Details |
---|---|
Facet |
The description of the application context facet value, see also ApplicationContextFacet. Type: tm1.ApplicationContextFacet Partner: Values Nullable: false |
Attachment
An attached document that provides details and background.
Key: Name
HasStream: true
Name | Details |
---|---|
Name |
The name of the attachment. Type: Edm.String Nullable: false |
Description |
A description of the attachment. Type: Edm.String |
ContentType |
The type of content in the attachment. Type: Edm.String |
Size |
The size of the attachment. Type: Edm.Int64 |
AttributeDefinition
An interface to describe an attribute.
Added: 10.2.2.1
Key: Name
Name | Details |
---|---|
Name |
The name of the attribute. Type: Edm.String Nullable: false |
Type |
The type of the attribute. Type: tm1.AttributeType Nullable: false |
AuditDetail
An audit detail entry contained by an expandable audit log entry.
An audit detail entry of an expandable audit log that includes detailed actions.
Added: 11.6.0
Key: ID
Name | Details |
---|---|
ID |
The ID of this audit detail entry. ID is not designed for indexing or filtering. Type: Edm.Int64 Nullable: false |
TimeStamp |
The date and time of this audit detail entry. Type: Edm.DateTimeOffset Nullable: false |
UserName |
The user who is recorded by this audit detail entry. Type: Edm.String |
Description |
The description of this audit detail entry. Type: Edm.String Nullable: false |
ObjectType |
The object type of this audit detail entry. Type: Edm.String Nullable: false |
ObjectName |
The object name of this audit detail entry. Type: Edm.String Nullable: false |
AuditLogEntry
An audit log entry in the audit log.
An audit log entry that contains timestamp, user name, object type, object name and descriptions.
Added: 11.6.0
Key: ID
Name | Details |
---|---|
ID |
The ID of audit log entry. ID is not designed for indexing or filtering. Type: Edm.Int64 Nullable: false |
TimeStamp |
The date and time of this audit log entry. Type: Edm.DateTimeOffset Nullable: false |
UserName |
The user who is recorded by this audit log entry. Type: Edm.String |
Description |
The description of this audit log entry. Type: Edm.String Nullable: false |
ObjectType |
The type of this audit log entry. Type: Edm.String Nullable: false |
ObjectName |
The name of this audit log entry. Type: Edm.String Nullable: false |
Name | Details |
---|---|
AuditDetails |
The collection of audit detail entries that are contained by this audit log entry. Type: Collection(tm1.AuditDetail) |
Cellset
The result of an execution of a view or an MDX expression.
A cellset represents a snapshot of your data at a certain point in time. You can use the cellset ID within a session instead of running a view or MDX multiple times. Running a view or MDX expression multiple times can yield different results each time and can have an impact on memory resources. When operations on a cellset have completed, you should delete the cellset if you are not ending the session. When a session ends, the cellset is deleted automatically.
Key: ID
Name | Details |
---|---|
ID |
Read-only property that provides a unique identifier for the cellset for the current session. The ID does not persist outside of a session because a cellset is transient. You cannot depend on the ID being consistent. If you try to access a cellset by using a previous ID value after the session has ended or when the cellset has been deleted, an error is received. Type: Edm.String Nullable: false |
Name | Details |
---|---|
Cube |
The contents of the cellset. Type: tm1.Cube Nullable: false |
Axes |
A collection of axes for the cellset. Type: Collection(tm1.CellsetAxis) ContainsTarget: true |
Cells |
Individual cell value that makes up part of the cellset. Type: Collection(tm1.CellsetCell) ContainsTarget: true |
CellsetAxis
Key: Ordinal
Name | Details |
---|---|
Ordinal |
A number that identifies an entity's position in a series. Type: Edm.Int32 Nullable: false |
Cardinality |
The cardinality of the cellset axis. Type: Edm.Int32 |
Name | Details |
---|---|
Hierarchies |
A collection of hierarchies for this cellset axis. Type: Collection(tm1.Hierarchy) |
Tuples |
A collection of tuples for this cellset axis. Type: Collection(tm1.CellsetAxisTuple) ContainsTarget: true |
CellsetAxisTuple
Key: Ordinal
Name | Details |
---|---|
Ordinal |
A number that identifies an entity's position in a series. Type: Edm.Int32 Nullable: false |
Name | Details |
---|---|
Members |
A collection of members that make up this cellset axis. Type: Collection(tm1.TupleMember) |
CellsetCell
A cell in a cellset.
Key: Ordinal
Name | Details |
---|---|
Ordinal |
A number that identifies an entity's position in a series. Type: Edm.Int64 Nullable: false |
Status |
The status of the cell, that is, NULL, DATA, or ERROR. Type: tm1.CellStatus Nullable: false |
Value |
The value of the cell in the cellset. Type: Edm.PrimitiveType |
FormatString |
The format of the cell in the cellset. Type: Edm.String |
FormattedValue |
The formatted value of the cell in the cellset. Type: Edm.String |
Updateable |
A value that indicates whether the cell is updateable. Type: Edm.Int32 This Cellset cell property can have the following values: #define TM1_CELL_NOT_ENABLED_SECURE 0x00000001 #define TM1_CELL_UPDATE 0x00000002 #define TM1_CELL_RULEDERIVED 0x00000004 //if bit 3 is set( count start from right), it is a rule derived. #define TM1_CELL_HASPICKLIST 0x00000008 //cell has an available pick list of appropriate input values. #define TM1_CELL_DIFFERS_FROM_BASE 0x00000010 // Value differs from base (sandbox): 5th bit set #define TM1_CELL_HASDRILLTHROUGH 0X00000020 #define TM1_SPREAD_NOHOLD 0x00000100 //default is no hold: bit 9 is set #define TM1_SPREAD_LEAFHOLD 0x00000200 //leaf hold :the 10th bit 10 is set #define TM1_SPREAD_CONSOLIDATIONHOLD 0x00000400 //Temporary hold :bit 12 is set. #define TM1_SPREAD_TEMPORARYHOLD 0x00000800 //Consolidation hold :bit 11 is set CellNotALeaf 0x1000 CellHasRule 0x2000 CellNoWriteAccess 0x3000 |
RuleDerived |
A Boolean that indicates whether the cell is rule derived. Type: Edm.Boolean |
Annotated |
A Boolean that indicates whether the cell is annotated. Type: Edm.Boolean |
Consolidated |
A Boolean that indicates whether the cell is consolidated. Type: Edm.Boolean |
NullIntersected |
Type: Edm.Boolean |
Language |
The language of the value of the cell. Type: Edm.Int32 |
HasPicklist |
A Boolean that indicates whether the value of the cell can be selected from a drop-down list. Added: 10.2.2.1 Type: Edm.Boolean |
PicklistValues |
The collection of available values that can be selected from the drop-down list. Added: 10.2.2.1 Type: Collection(Edm.String) |
HasDrillthrough |
A Boolean that indicates whether drill-through scripts are defined on the cell. Added: 10.2.2.6 Type: Edm.Boolean |
Name | Details |
---|---|
DrillthroughScripts |
The collection of drill throughs. Added: 10.2.2.6 Type: Collection(tm1.Drillthrough) |
Members |
A collection of all members that represent the location, the tuple if you will, of this cell in the cube. Using the cellset's Cells property and expending this Members property effectively returns the flattened cellset. Added: 10.2.2.7 Type: Collection(tm1.Member) |
Chore
Objects that execute one or more processes of TM1 at a user-defined frequency.
Added: 10.2.2.1
Key: Name
Name | Details |
---|---|
Name |
The name of the chore. Type: Edm.String Nullable: false |
StartTime |
The UTC date-time defining the start time of the chore, independent of DST. Type: Edm.DateTimeOffset Nullable: false |
DSTSensitive |
A Boolean that indicates whether the chore start time is sensitive to daily savings time. Type: Edm.Boolean Nullable: false |
Active |
A Boolean that indicates whether the chore is active. Type: Edm.Boolean Nullable: false |
ExecutionMode |
The execution mode of the chore, that is, single or multiple commit. Type: tm1.ChoreExecutionMode Nullable: false |
Frequency |
The frequency of the chore. Type: Edm.Duration |
Attributes |
The attributes of the chore. Type: tm1.Attributes |
Name | Details |
---|---|
LocalizedAttributes |
Translated string values for properties of the chore. Type: Collection(tm1.LocalizedAttributes) ContainsTarget: true |
Tasks |
A collection of tasks that make up the chore. Type: Collection(tm1.ChoreTask) Partner: Chore ContainsTarget: true |
ChoreReference
A reference to a chore.
Added: 10.2.2.1
BaseType: tm1.Entry
Name | Details |
---|---|
Chore |
The chore that is referenced. Type: tm1.Chore |
ChoreTask
A task to be completed as part of a Chore.
Added: 10.2.2.1
Key: Step
Name | Details |
---|---|
Step |
A step in a task. Type: Edm.Int64 Nullable: false |
Parameters |
A collection of parameters for the task. Type: Collection(tm1.ChoreTaskParameter) |
Name | Details |
---|---|
Process |
The process completed in the task. Type: tm1.Process |
Chore |
The Chore that the task belongs to. Deprecated: 11.4.0 Type: tm1.Chore Partner: Tasks Nullable: false |
Configuration
Specifies configuration parameters as defined in the Tm1s.cfg file for an IBM Cognos TM1 server.
For details about all of the parameters, refer to the comments in the Tm1s.cfg file and the Operations Guide.
Key: ServerName
Name | Details |
---|---|
ServerName |
The name of the server. Type: Edm.String Nullable: false |
AdminHost |
The location where TM1 Admin Server is running. Type: Edm.String |
ProductVersion |
The product version of the TM1 server. Type: Edm.String |
PortNumber |
The port number of the TM1 server, which is used to distinguish between multiple servers running on the same computer. Type: Edm.Int32 |
ClientMessagePortNumber |
A secondary port used to accept client messages concerning the progress and ultimate cancellation of a lengthy operation without tying up thread reserves. Type: Edm.Int32 |
HTTPPortNumber |
The port number on which the TM1 server listens for incoming HTTP(S) requests. Type: Edm.Int32 |
IntegratedSecurityMode |
A Boolean that indicates whether the TM1 server uses integrated security modes. Type: Edm.Boolean |
SecurityMode |
The user authentication mode to be used by TM1 server. Type: Edm.String |
PrincipalName |
The service principal name (SPN) when using Integrated Login with TM1 Web and constrained delegation. Type: Edm.String |
SecurityPackageName |
If you configure the TM1 server to use Integrated Login, the SecurityPackageName parameter defines the security package that authenticates your user name and password in Microsoft Windows. Type: Edm.String |
ClientCAMURIs |
A collection of URIs used to authenticate TM1 clients. Type: Collection(Edm.String) |
WebCAMURI |
The URI used to authenticate TM1 Web clients. Type: Edm.String |
ClientPingCAMPassport |
Indicates the interval, in seconds, that a client should ping the CAM server to keep their passport alive. Type: Edm.Int32 |
ServerCAMURI |
Specifies the URI for the internal dispatcher that the TM1 server should use to connect to Cognos Authentication Manager (CAM). Type: Edm.String |
AllowSeparateNandCRules |
Lets you specify rule expressions for N: and C: levels on separate lines using identical AREA definitions. Type: Edm.Boolean |
DistributedOutputDir |
Defines the directory to which TUnits are written when a Cognos Insight distributed application is deployed. Type: Edm.String |
DisableSandboxing |
A Boolean that indicates whether users have the ability to use sandboxes across the server. Type: Edm.Boolean |
JobQueuing |
A Boolean that indicates whether the TM1 server should use queues to merge sandboxes. Type: Edm.Boolean |
ForceReevaluationOfFeedersForFedCellsOnDataChange |
When this parameter is set, a feeder statement is forced to be re-evaluated when data changes. Type: Edm.Boolean |
DataBaseDirectory |
Specifies the data directory from which the server loads cubes, dimensions, and other objects. Type: Edm.String |
UnicodeUpperLowerCase |
Instructs the TM1 server to identify and handle Unicode object names, preventing the creation of identical Unicode object names that vary only in case. Type: Edm.Boolean |
Cube
Represents a single cube on a TM1 server.
Key: Name
Name | Details |
---|---|
Name |
Name of the cube as it is registered on the server. Type: Edm.String Nullable: false |
Rules |
Cube rules expand the standard hierarchical consolidation operations that you may define within a dimension. Type: Edm.String |
DrillthroughRules |
Rules associating drill-through scripts with regions of cells in the cube. Drill-through processes can return query results against either cubes or relational tables. Added: 10.2.2.6 Type: Edm.String |
LastSchemaUpdate |
Last schema update date of the cube. Type: Edm.DateTimeOffset |
LastDataUpdate |
Last data update date of the cube. Type: Edm.DateTimeOffset |
Attributes |
Captions and resource attributes of the cube. Type: tm1.Attributes |
Name | Details |
---|---|
Dimensions |
Represents dimensions that perform calculations, control labels, and format data entry. Type: Collection(tm1.Dimension) |
Views |
Represents a View object on the TM1 Server. A View is a child object of a Cube. You can retrieve a list of available Views, or find a specific View using the appropriate methods in the Cube class. View objects can be queried for information (such as name or subsets) or changed. Executing a View results in a Cellset object, which can be used to read the actual cell data. Type: Collection(tm1.View) Partner: Cube ContainsTarget: true |
ViewAttributes |
Specific attributes for each View object of the cube. Type: Collection(tm1.AttributeDefinition) ContainsTarget: true |
PrivateViews |
Private views are accessible only by the user who registered them. A private registered view is a named object. It persists after the termination of a client session. Type: Collection(tm1.View) Partner: Cube ContainsTarget: true |
Annotations |
Comments that provide additional information about the cube. Type: Collection(tm1.Annotation) |
LocalizedAttributes |
Translated string values for properties of the cube. Type: Collection(tm1.LocalizedAttributes) ContainsTarget: true |
CubeDrillthrough
CubeReference
A reference to a cube.
Added: 10.2.2.1
BaseType: tm1.Entry
Name | Details |
---|---|
Cube |
The cube that is referenced. Type: tm1.Cube |
Dimension
Represents a single dimension on a TM1 server.
A dimension is a broad grouping of descriptive data about a major aspect of a business, such as products, dates, or locations. Each dimension includes different levels of members in one or more hierarchies and an optional set of calculated members or special categories.
Key: Name
Name | Details |
---|---|
Name |
The name of the dimension. Type: Edm.String Nullable: false |
UniqueName |
The caption for the dimension. Type: Edm.String |
AllLeavesHierarchyName |
The name of the all leaves hierarchy in a dimension with alternate hierarchies. Defaults to 'Leaves' if no name is specified. A dimension with more than one hierarchy automatically gets a, system maintained, all leaves hierarchy. The name of this hierarchy, if no name is specified this hierarchy is called "Leaves", can be controlled with this AllLeavesHierarchyName property. Note that the all leaves hierarchy can also be added by calling the AddAllLeavesHierarchy action, which converts the dimension into a multi hierarchy dimension, if not one already, by adding a second, in this case the all leaves, hierarchy. Added: 11.0.0 Type: Edm.String |
Attributes |
A property of the dimension. Attributes have a finite domain within the context of the dimension that they belong to. For example, a dimension for a customer may have attributes that describe the city, region, and country that the customer belongs to. Type: tm1.Attributes |
Name | Details |
---|---|
Hierarchies |
More specific groupings within a dimension. For example, for the Years dimension, data can be organized into smaller groups, such as Years, Current Month, and All Dates. Type: Collection(tm1.Hierarchy) Partner: Dimension ContainsTarget: true |
DefaultHierarchy |
The default hierarchy of the dimension. Added: 10.2.2.5 Type: tm1.Hierarchy |
HierarchyAttributes |
Attributes of a hierarchy. Type: Collection(tm1.AttributeDefinition) ContainsTarget: true |
LocalizedAttributes |
Translated string values for properties of the dimensions. Type: Collection(tm1.LocalizedAttributes) ContainsTarget: true |
DimensionReference
A reference to a dimension.
Added: 10.2.2.1
BaseType: tm1.Entry
Name | Details |
---|---|
Dimension |
The dimension that is referenced. Type: tm1.Dimension |
Document
An attached document.
Added: 10.2.2.1
BaseType: tm1.Entry
Name | Details |
---|---|
Size |
The size of the document. Type: Edm.Int64 |
LastUpdated |
The date and time value of the last update of this document, with a time zone offset. Added: 11.1.0 Type: Edm.DateTimeOffset |
Content |
The contents of the document. Type: Edm.Stream |
DocumentReference
A reference to a document.
Added: 10.2.2.1
BaseType: tm1.Entry
Name | Details |
---|---|
Document |
The document that is referenced. Type: tm1.Document |
Drillthrough
The definition of a drill through on the current cell.
Added: 10.2.2.6
Key: Name
Abstract: true
Name | Details |
---|---|
Name |
The name of the drill through. Type: Edm.String Nullable: false |
Edge
Represents the relationship between two or more hierarchies and their weight.
Key: ParentName, ComponentName
Name | Details |
---|---|
ParentName |
The name of the parent of the component in the hierarchy. Type: Edm.String Nullable: false |
ComponentName |
The name of the component in the hierarchy. Type: Edm.String Nullable: false |
Weight |
The weight of the component in the edge. Type: Edm.Double |
Name | Details |
---|---|
Hierarchy |
The hierarchy of the component in the edge. Type: tm1.Hierarchy Partner: Edges Nullable: false |
Parent |
The parent of the component. Type: tm1.Element Nullable: false |
Component |
The component. Type: tm1.Element Nullable: false |
Element
An element in a dimension that identifies the location of a cell in a cube.
Key: Name
Name | Details |
---|---|
Name |
The name of the element. Type: Edm.String Nullable: false |
UniqueName |
The element's invariant name. Type: Edm.String |
Type |
The type of the element, one of Numeric, String, or Consolidated. Type: tm1.ElementType |
Level |
The level to which the element belongs within the dimension hierarchy. Level 0 identifies leaf elements. Each level of consolidation within the dimension hierarchy is incremented by 1. Type: Edm.Int32 |
Index |
A value that corresponds to the position of the element within a dimension. The first element within a dimension has an index value of 1, the second element has an index value of 2, and so on. Type: Edm.Int32 |
Attributes |
The attributes of the element. Type: tm1.Attributes |
Name | Details |
---|---|
Hierarchy |
The hierarchy of the element in the dimension. Type: tm1.Hierarchy Partner: Elements Nullable: false |
Parents |
The parent element of the element in the hierarchy. Type: Collection(tm1.Element) |
Components |
The collection of elements in the dimension. Type: Collection(tm1.Element) |
Edges |
The collection of edges in the dimension. Type: Collection(tm1.Edge) |
LocalizedAttributes |
Translated string values for properties of the element. Type: Collection(tm1.LocalizedAttributes) ContainsTarget: true |
Entry
An entry.
Added: 10.2.2.1
Key: Name
Name | Details |
---|---|
ID |
The ID of the entry. Deprecated: 11.5.0 Type: Edm.String Nullable: false |
Name |
The name of the entry. Type: Edm.String Nullable: false |
Attributes |
The attributes of the entry. Type: tm1.Attributes |
Name | Details |
---|---|
ContainedBy |
The folder that contains the entries. Type: tm1.Folder |
LocalizedAttributes |
Translated string values for properties of the entry. Type: Collection(tm1.LocalizedAttributes) ContainsTarget: true |
ErrorLogFile
An error log file
Added: 11.3.0
Key: Filename
Name | Details |
---|---|
Filename |
The name of the error log file. Type: Edm.String Nullable: false |
Content |
The content of the process error. Type: Edm.Stream |
Folder
A container for related TM1 objects.
Added: 10.2.2.1
BaseType: tm1.Entry
Name | Details |
---|---|
Contents |
A collection of entries that are in the folder. Type: Collection(tm1.Entry) ContainsTarget: true |
PrivateContents |
A collection of private entries that are in the folder. Type: Collection(tm1.Entry) ContainsTarget: true |
GitPlan
A plan of pulling or pushing the source of server objects.
Added: 11.5.0
Key: ID
Abstract: true
Name | Details |
---|---|
ID |
The ID of the plan. Type: Edm.String Nullable: false |
Branch |
The name of the remote branch. Type: Edm.String Nullable: false |
Force |
A flag which is used to evaluate preconditions. Type: Edm.Boolean Nullable: false |
GitPullPlan
A plan of pulling source from a remote Git commit.
Added: 11.5.0
BaseType: tm1.GitPlan
Name | Details |
---|---|
Commit |
The Git commit which contains the source. Type: tm1.GitCommit Nullable: false |
Operations |
The operations that will be performed to read in the resource. Type: Collection(Edm.String) |
ExecutionMode |
The execution mode of the Git pull plan, that is, single or multiple commit. Type: tm1.GitPlanExecutionMode Nullable: false |
GitPushPlan
A plan of pushing server objects to remote Git repository.
Added: 11.5.0
BaseType: tm1.GitPlan
Name | Details |
---|---|
NewBranch |
The name of the new branch to which the source to be pushed. Type: Edm.String Nullable: false |
NewCommit |
The commit that contains the source generated for the push. Type: tm1.GitCommit Nullable: false |
ParentCommit |
The parent commit of the new commit. Type: tm1.GitCommit Nullable: false |
SourceFiles |
A collection of the sources files in the commit. Type: Collection(Edm.String) |
Group
A user group on a TM1 server.
Key: Name
Name | Details |
---|---|
Name |
The name of a user group on the TM1 server. There are three predefined groups on each server: Admin, DataAdmin, and SecurityAdmin. Other user groups can be created by an administrator as required. Type: Edm.String Nullable: false |
Name | Details |
---|---|
Users |
The names of users in a given group. Type: Collection(tm1.User) Partner: Groups |
Hierarchy
A hierarchy organizes dimensions into a hierarchical structure, with each dimension representing a different level of the hierarchy.
For example, you have separate dimensions for days, months, and quarters. You group them into a dimension called year.
Key: Name
Name | Details |
---|---|
Name |
The name of the hierarchy. Type: Edm.String Nullable: false |
UniqueName |
The caption of the hierarchy. Type: Edm.String |
Cardinality |
The cardinality of a relationship is the number of related rows for each of the two query subjects. Relationships exist between two query subjects. The cardinality of a relationship is the number of related rows for each of the two query subjects. The rows are related by the expression of the relationship. This expression usually refers to the primary and foreign keys of the underlying tables. Type: Edm.Int32 |
Structure |
Specifies whether the hierarchy is balanced or unbalanced. A value of 0 indicates a balanced structure and a value of 2 indicates an unbalanced structure. Type: Edm.Int32 |
Visible |
Indicates if this hierarchy should be visible to consumers. A designer of a dimension might opt to use additional hierarchies for modeling purposes and express his or her preference to not make such hierarchy 'visible' using this property. A consumer however is free to ignore this flag, like modeling clients would obviously, if such behavior would be more appropriate. Note: this flag has absolutely no meaning to the server! Added: 11.0.0 Type: Edm.Boolean |
Attributes |
The attributes of the hierarchy. Type: tm1.Attributes |
Name | Details |
---|---|
Dimension |
A dimension that is part of the hierarchy. Type: tm1.Dimension Partner: Hierarchies Nullable: false |
Elements |
The elements of the hierarchy. Type: Collection(tm1.Element) Partner: Hierarchy ContainsTarget: true |
Edges |
The edges of the hierarchy. Type: Collection(tm1.Edge) Partner: Hierarchy ContainsTarget: true |
Subsets |
The subsets of the hierarchy. Type: Collection(tm1.Subset) Partner: Hierarchy ContainsTarget: true |
PrivateSubsets |
The private subsets of the hierarchy. Type: Collection(tm1.Subset) Partner: Hierarchy ContainsTarget: true |
SessionSubsets |
The session-scoped subsets generated on this hierarchy. This collection will always appear empty, like the Cellsets collection, but generated SessionSubsets can be retrieved directly by ID. Type: Collection(tm1.Subset) Partner: Hierarchy ContainsTarget: true |
Members |
The members of the hierarchy. Type: Collection(tm1.Member) Partner: Hierarchy ContainsTarget: true |
AllMember |
An aggregation of all of the members of the hierarchy. Type: tm1.Member Partner: Hierarchy |
DefaultMember |
The default member of the hierarchy. Type: tm1.Member Partner: Hierarchy |
Levels |
A collection of levels in the hierarchy. Type: Collection(tm1.Level) Partner: Hierarchy ContainsTarget: true |
LocalizedAttributes |
Translated string values for properties of the hierarchy. Type: Collection(tm1.LocalizedAttributes) ContainsTarget: true |
ElementAttributes |
The attributes of the elements of the hierarchy. Added: 10.2.2.1 Type: Collection(tm1.AttributeDefinition) ContainsTarget: true |
SubsetAttributes |
The attributes of the subsets of the hierarchy. Type: Collection(tm1.AttributeDefinition) ContainsTarget: true |
Level
A level in the hierarchy of a set of cubes.
Key: Number
Name | Details |
---|---|
Number |
The level number. Type: Edm.Int32 Nullable: false |
Name |
The name of the level. Type: Edm.String Nullable: false |
UniqueName |
The unique name of the level. Type: Edm.String |
Cardinality |
The cardinality of the level, that is, the number of elements in the level. Type: Edm.Int32 |
Type |
The type of the level. Type: Edm.Int32 |
Name | Details |
---|---|
Hierarchy |
The hierarchy of the level. Type: tm1.Hierarchy Partner: Levels Nullable: false |
Members |
The members of the level. Type: Collection(tm1.Member) Partner: Level |
Link
A link to another website or resource.
Added: 10.2.2.1
BaseType: tm1.Entry
Name | Details |
---|---|
URL |
The URL of the link. Type: Edm.String Nullable: false |
LocalizedAttributes
A combination of international language codes defined by ISO 639-1 to identify major languages and IETF language tags to identify specific locales.
For example, "fr" identifies French and "fr-CA" identifies Canadian French.
Key: LocaleID
Name | Details |
---|---|
LocaleID |
The ID of the locale. To use the default locale, specify 'Default'. Type: Edm.String Nullable: false |
Attributes |
A set of attributes for the locale. Type: tm1.Attributes |
Logger
A logger to be configured for a TM1 server.
Added: 10.2.2.6
Key: Name
Name | Details |
---|---|
Name |
The name of the logger. Type: Edm.String Nullable: false |
Level |
The level of the logger, that is, Fatal, Error, Warning, Info, Debug, Unknown, or Off. Type: tm1.LogLevel Nullable: false |
MDXView
A view of a cube that is defined by an MDX expression.
OpenType: true
BaseType: tm1.View
Name | Details |
---|---|
MDX |
An MDX expression that defines a cube view. Type: Edm.String Nullable: false |
Member
A set of elements that are members of the consolidation.
Key: Name
Name | Details |
---|---|
Name |
The name of the member. Type: Edm.String Nullable: false |
UniqueName |
The name of the member, preceded by the name of the parent, for example, [dimension_name]:[member_name]. Type: Edm.String |
Type |
The type of the member. Type: tm1.MemberType |
Ordinal |
A number that identifies an entity's position in a series. Type: Edm.Int32 |
IsPlaceholder |
A Boolean that indicates whether this member is a placeholder. Type: Edm.Boolean |
Weight |
The weight of the member within a consolidation. Weight is a factor applied to an individual member when summing the members of a consolidation. Type: Edm.Double |
Attributes |
The attributes of the member. Type: tm1.Attributes |
Name | Details |
---|---|
Hierarchy |
The hierarchy of the member. Type: tm1.Hierarchy Partner: Members Nullable: false |
Level |
The level within the hierarchy on which this member resides. Added: 10.2.2.5 Type: tm1.Level Partner: Members Nullable: false |
Element |
The member element. Type: tm1.Element Nullable: false |
Parent |
The parent of the member in the consolidation. Type: tm1.Member Partner: Children |
Children |
The children of the member in the consolidation. Type: Collection(tm1.Member) Partner: Parent |
LocalizedAttributes |
Translated string values for properties of the member. Type: Collection(tm1.LocalizedAttributes) ContainsTarget: true |
MessageLogEntry
An entry in the message log.
The message log displays status messages on the activity of the TM1 server in a log file. These messages contain details on activity such as executed processes, chores, loaded cubes and dimensions, and synchronized replication.
Added: 10.2.2.1
Key: ID
Name | Details |
---|---|
ID |
The ID of the message log entry. Type: Edm.Int64 Nullable: false |
ThreadID |
The thread ID of the message log entry. Type: Edm.Int64 |
SessionID |
The session ID of the message log entry. Type: Edm.Int64 |
Level |
The level of the message log entry, that is, Fatal, Error, Warning, Info, Debug, Unknown, Off. Type: tm1.LogLevel Nullable: false |
TimeStamp |
The date and time of the message log entry. Type: Edm.DateTimeOffset |
Logger |
The logger of the message log entry. Type: Edm.String Nullable: false |
Message |
The message in the message log entry. Type: Edm.String Nullable: false |
NativeView
A native view of a cube.
OpenType: true
BaseType: tm1.View
Name | Details |
---|---|
Columns |
The dimension elements that exist on the column axis of a view. Type: Collection(tm1.ViewAxisSelection) |
Rows |
The dimension elements that exist on the row axis of a view. Type: Collection(tm1.ViewAxisSelection) |
Titles |
The dimension elements that exist as title (context) elements of a view. Type: Collection(tm1.ViewTitle) |
SuppressEmptyColumns |
A Boolean that suppresses any columns that contain only zero values. Type: Edm.Boolean |
SuppressEmptyRows |
A Boolean that suppresses any rows that contain only zero values. Type: Edm.Boolean |
FormatString |
The format of the elements in the view. Type: Edm.String Nullable: false |
Process
A TurboIntegrator process that can be used to manipulate TM1 data and metadata.
Key: Name
Name | Details |
---|---|
Name |
The name of a TurboIntegrator process. Type: Edm.String Nullable: false |
HasSecurityAccess |
A Boolean that indicates whether the user security access to run this process. Type: Edm.Boolean |
PrologProcedure |
The code that is executed during the Prolog stage of the process. Type: Edm.String |
MetadataProcedure |
The code that is executed during the Metadata stage of the process. Type: Edm.String |
DataProcedure |
The code that is executed during the Data stage of the process. Type: Edm.String |
EpilogProcedure |
The code that is executed during the Epilog stage of the process. Type: Edm.String |
DataSource |
The source of the data for the process. Type: tm1.ProcessDataSource |
Parameters |
Parameters used by the process. Type: Collection(tm1.ProcessParameter) |
Variables |
Variables used by the process. Type: Collection(tm1.ProcessVariable) |
Attributes |
The attributes of the process. Type: tm1.Attributes |
Name | Details |
---|---|
LocalizedAttributes |
Translated string values for properties of the process. Type: Collection(tm1.LocalizedAttributes) ContainsTarget: true |
ErrorLogs |
A collection of error logs for the process. Added: 10.2.2.2 Type: Collection(tm1.ProcessErrorLog) ContainsTarget: true |
ProcessDebugContext
A debug session of a TurboIntegrator process.
Added: 11.0.0
Key: ID
Name | Details |
---|---|
ID |
Type: Edm.String Nullable: false |
Status |
The state of the process that is being debugged. Type: tm1.ProcessDebugContextStatus Nullable: false |
LastActivityDuration |
The number of milliseconds that have elapsed since the last debug action. Type: Edm.Int64 |
ObjectLocks |
A collection of object locks that are held by the TurboIntegrator process under debug. Type: Collection(tm1.ProcessDebugContextObjectLock) |
Result |
Once the process execution has completed this contains the execution results. Type: tm1.ProcessExecuteResult |
Name | Details |
---|---|
CurrentBreakpoint |
The breakpoint that the process is currently paused at. Type: tm1.ProcessDebugContextBreakpoint |
Process |
The TurboIntegrator process passed to the debug action. Type: tm1.Process Nullable: false |
CallStack |
The execution stack that represents the current execution state. Type: Collection(tm1.ProcessDebugContextStackFrame) ContainsTarget: true |
Breakpoints |
A list of breakpoints that apply to this debug session. Type: Collection(tm1.ProcessDebugContextBreakpoint) ContainsTarget: true |
Thread |
The thread that is executing the process for the debug session. Type: tm1.Thread |
ProcessDebugContextBreakpoint
A conditional expression that gets evaluated each time the breakpoint is hit. If the expression evaluates to true, execution is paused. Otherwise execution continues.
Valid operators are '=', '<>', '@=', '@<>', '<', '<=', '>', '>=', '&', '%', '~', '+', '-', '*', '/', '\', '^', '|'. Parenthesis and variable names are also supported. Function calls are not allowed. These operators should have the same semantics when used here as they would if used in a TurboIntegrator script.
Added: 11.0.0
Key: ID
Abstract: true
Name | Details |
---|---|
ID |
Type: Edm.Int32 Nullable: false |
Enabled |
Type: Edm.Boolean Nullable: false |
HitMode |
Type: tm1.ProcessDebugContextHitMode Nullable: false |
HitCount |
Type: Edm.Int64 |
Expression |
Type: Edm.String |
ProcessDebugContextDataBreakpoint
A breakpoint that pauses execution when the named variable is written to.
Added: 11.0.0
BaseType: tm1.ProcessDebugContextBreakpoint
Name | Details |
---|---|
VariableName |
Type: Edm.String Nullable: false |
ProcessDebugContextLineBreakpoint
A breakpoint that pauses execution at a specific script line.
Added: 11.0.0
BaseType: tm1.ProcessDebugContextBreakpoint
Name | Details |
---|---|
ProcessName |
Type: Edm.String Nullable: false |
Procedure |
Type: tm1.ProcessProcedure Nullable: false |
LineNumber |
Type: Edm.Int32 Nullable: false |
ProcessDebugContextLockBreakpoint
A breakpoint that pauses execution when an object lock is acquired.
Added: 11.0.0
BaseType: tm1.ProcessDebugContextBreakpoint
Name | Details |
---|---|
ObjectName |
Type: Edm.String Nullable: false |
ObjectType |
Type: Edm.String Nullable: false |
LockMode |
Type: tm1.ProcessDebugContextLockMode Nullable: false |
ProcessDebugContextStackFrame
A single frame in the execution stack.
Added: 11.0.0
Key: ID
Name | Details |
---|---|
ID |
Type: Edm.String Nullable: false |
Procedure |
Type: tm1.ProcessProcedure Nullable: false |
LineNumber |
Type: Edm.Int32 Nullable: false |
RecordNumber |
Type: Edm.Int32 |
Name | Details |
---|---|
Process |
Type: tm1.Process Nullable: false |
Variables |
The entire list of active variables available to the process. Type: Collection(tm1.ProcessDebugContextVariable) ContainsTarget: true |
ProcessDebugContextVariable
Added: 11.0.0
Key: Name
Name | Details |
---|---|
Name |
Type: Edm.String Nullable: false |
Value |
Type: Edm.PrimitiveType |
ProcessErrorLog
A process error log entry.
Added: 10.2.2.2
Deprecated: 11.3.0
Key: Timestamp
Name | Details |
---|---|
Timestamp |
The date and time of the process error. Type: Edm.DateTimeOffset Nullable: false |
Content |
The content of the process error. Type: Edm.Stream |
ProcessReference
A reference to a process.
Added: 10.2.2.1
BaseType: tm1.Entry
Name | Details |
---|---|
Process |
The process that is referenced. Type: tm1.Process |
RelationalDrillthrough
A drill through that drills to an Open Database Connectivity (ODBC) table.
Added: 10.2.2.6
BaseType: tm1.Drillthrough
Rowset
The result of an execution of a relational drillthrough.
Added: 11.6.0
Key: ID
Name | Details |
---|---|
ID |
Read-only property that provides a unique identifier for the rowset for the current session. Type: Edm.String Nullable: false |
Name | Details |
---|---|
Rows |
Individual row value that makes up part of the rowset. Type: Collection(tm1.RowsetRow) ContainsTarget: true |
RowsetRow
A row in a rowset.
Added: 11.6.0
Key: Ordinal
OpenType: true
Name | Details |
---|---|
Ordinal |
A number that identifies an entity's position in a series. Type: Edm.Int64 Nullable: false |
SQLDataSource
A representation of a SQL (read: ODBC) data source available on the host on which the TM1 server is running.
Added: 11.2.0
Key: Name
Name | Details |
---|---|
Name |
The name of the SQL data source. Type: Edm.String Nullable: false |
Description |
A description of the data source. Type: Edm.String |
Sandbox
A sandbox that allows you to work with your data without affecting your base.
Sandboxes allow you to work with your data in different versions, allowing you to add or modify it to see the results without affecting your base. Changes that you make in a sandbox are not made public until you commit the changes. You can continue to work with your data until you are satisfied with the result.
Key: Name
Name | Details |
---|---|
Name |
The name of a sandbox. Type: Edm.String Nullable: false |
IsLoaded |
A Boolean that specifies whether the sandbox is loaded into memory. Read-only. Type: Edm.Boolean |
IsActive |
A Boolean that indicates whether the current context is an active sandbox. Used when the !sandbox parameter is used as a query option. Type: Edm.Boolean |
IsQueued |
A Boolean that indicates whether the current context is queued and therefore read-only. Type: Edm.Boolean |
IncludeInSandboxDimension |
A Boolean that indicates whether the sandbox is to be included in the sandbox dimension. Added: 11.0.0 Type: Edm.Boolean |
Server
A read-only collection of properties of the running server. Available without authenticating.
Added: 11.0.0
Key: Name
Name | Details |
---|---|
Name |
The name of the server. Type: Edm.String Nullable: false |
ProductVersion |
The product version of the TM1 server. Type: Edm.String |
PortNumber |
The port number of the TM1 server, which is used to distinguish between multiple servers running on the same computer. Type: Edm.Int32 |
ClientMessagePortNumber |
A secondary port used to accept client messages concerning the progress and ultimate cancellation of a lengthy operation without tying up thread reserves. Type: Edm.Int32 |
HTTPPortNumber |
The port number on which the TM1 server listens for incoming HTTP(S) requests. Type: Edm.Int32 |
UsingSSL |
Whether or not the server is configured to use SSL for client connections. Type: Edm.Boolean |
SecurityPackageName |
If you configure the TM1 server to use Integrated Login, the SecurityPackageName parameter defines the security package that authenticates your user name and password in Microsoft Windows. Type: Edm.String |
ServicePrincipalName |
The service principal name (SPN) when using Integrated Login with TM1 Web and constrained delegation. Type: Edm.String |
IntegratedSecurityMode |
The authentication scheme supported by TM1 Server. Type: tm1.SecurityMode |
ClientCAMURI |
The URI clients use to connect to the CAM provider to retrieve a CAM passport. Type: Edm.String |
ClientPingCAMPassport |
Indicates the interval, in seconds, that a client should ping the CAM server to keep their passport alive. Type: Edm.Int32 |
ServerSettings
The settings for a TM1 server.
Added: 11.0.0
Key: ServerName
Name | Details |
---|---|
ServerName |
The name of the TM1 server. Type: Edm.String Nullable: false |
Access |
The access settings of the TM1 server, that is, network, authentication, SSL, CAM, LDAP, CAPI, and HTTP settings. Type: tm1.AccessSettings |
Administration |
The administration settings, including client, audit log, debug log, server log, Java, external database, and TM1 Web settings. Type: tm1.AdministrationSettings |
Modelling |
The modelling settings of the TM1 server. Type: tm1.ModellingSettings |
Performance |
The performance settings of the TM1 server. Type: tm1.PerformanceSettings |
Session
Represents a unique user session with the server.
Added: 10.2.2.5
Key: ID
Name | Details |
---|---|
ID |
The ID uniquely identifying the session. Type: Edm.Int64 Nullable: false |
Context |
The Context specified by the client to help identifying the consumer of this session. Added: 11.1.0 Type: Edm.String |
Active |
A Boolean indicating that the session is still considered active vs. closed with threads actively executing requests. Added: 11.5.0 Type: Edm.Boolean Nullable: false |
Name | Details |
---|---|
User |
The user that is associated to this session. Type: tm1.User Partner: Sessions Nullable: false |
Threads |
The names of users in a given group. Type: Collection(tm1.Thread) Partner: Session |
Subset
Key: Name
Name | Details |
---|---|
Name |
The name of the subset. Type: Edm.String Nullable: false |
UniqueName |
The name of the subset, preceded by the parent dimension and separated by a colon, for example, [dimension_name]:[subset_name]. Type: Edm.String |
Expression |
An MDX expression that defines the subset. Type: Edm.String |
Attributes |
The attributes of the subset. Type: tm1.Attributes |
Name | Details |
---|---|
Hierarchy |
The hierarchies that are included in the subset. Type: tm1.Hierarchy Nullable: false |
Elements |
The elements that are included in the subset. Type: Collection(tm1.Element) |
LocalizedAttributes |
Translated string values for properties of the subset. Type: Collection(tm1.LocalizedAttributes) ContainsTarget: true |
SubsetReference
A reference to a subset.
Added: 10.2.2.1
BaseType: tm1.Entry
Name | Details |
---|---|
Subset |
The subset that is referenced. Type: tm1.Subset |
Thread
A thread that can run queries concurrently on the TM1 server.
Added: 10.2.2.1
Key: ID
Name | Details |
---|---|
ID |
The ID of the thread. Added: 10.2.2.5 Type: Edm.Int64 Nullable: false |
Type |
The type of thread, that is, user, worker, chore, system. Type: tm1.ThreadType Nullable: false |
Name |
The name of the thread. Type: Edm.String Nullable: false |
Context |
The context of the thread. Type: Edm.String Nullable: false |
State |
The state of the thread. Type: Edm.String Nullable: false |
Function |
The function of the thread. Type: Edm.String Nullable: false |
ObjectType |
The object type of the thread. Type: Edm.String Nullable: false |
ObjectName |
The name of the object that the thread acts on. Type: Edm.String Nullable: false |
RLocks |
A shared lock that allows many threads to read from an object at the same time, but does not allow another thread to modify or write to this object until all R-locks have been released. Type: Edm.Int32 |
IXLocks |
A lock that reserves the right for a thread to obtain a W-lock on an object when all R-locks have been released. Type: Edm.Int32 |
WLocks |
An exclusive lock that allows only one thread at a time to access and write changes to an object. Type: Edm.Int32 |
ElapsedTime |
The elapsed time of a thread in seconds. Type: Edm.Duration |
WaitTime |
The wait time (delay) before a thread should start the process. Type: Edm.Duration |
Info |
The info of the thread. Type: Edm.String Nullable: false |
Name | Details |
---|---|
Session |
The Session that this thread is currently servicing. Type: tm1.Session Partner: Threads |
TransactionLogEntry
An entry in the transaction log.
The transaction log displays the transactions recorded in the Tm1s.log file when a TM1 client changes a cube value.
Added: 10.2.2.1
Key: ID
Name | Details |
---|---|
ID |
The ID of the transaction log entry. Type: Edm.Int64 Nullable: false |
ChangeSetID |
The ID of the changeset in the transaction log entry. Type: Edm.String |
TimeStamp |
The date and time of the transaction log entry. Type: Edm.DateTimeOffset |
ReplicationTime |
The replication time of the TM1 server for the transaction log entry. Type: Edm.DateTimeOffset |
User |
The user who completed the changeset in the transaction. Type: Edm.String |
Cube |
The cube that was acted on in the transaction. Type: Edm.String |
Tuple |
A collection of tuples that were acted on in the transaction. Type: Collection(Edm.String) |
OldValue |
The previous value of the changed tuple in the transaction. Type: Edm.PrimitiveType |
NewValue |
The new value of the changed tuple in the transaction. Type: Edm.PrimitiveType |
StatusMessage |
The status message of the transaction. Type: Edm.String |
TupleMember
Represents a member in a tuple on an axis in a query result.
Added: 11.2.0
BaseType: tm1.Member
Name | Details |
---|---|
DisplayInfo |
This property contains various items of information that help an application render the axis. The DisplayInfo property contains various items of information that help an application render the axis. It is a 4-byte value. The value of the least-significant byte of the least significant word contains the so called drill level. The drill level effectively represents the number of ancestors of a member that preceded the member, hence those ancestors being drilled down, without breaking ancestry. The most significant byte of the least significant word represents the level in the ancestry relative to the ancestor at the root of the tree. In the most-significant 2 bytes, each bit potentially conveys one piece of display information, however for only 3 bits (the least-significant bits) a meaning has been defined. The least-significant bit (rightmost bit), if set, indicates that this member is drilled down. That is, at least one descendant of this member appears on the axis, immediately following all occurrences of that member. The next bit (the second least-significant bit), if set, indicates that the parent of this member is the same as the parent of the member preceding all occurrences of the current member. The last bit (the third least-significant bit), if set, indicates that, with the exception of members that appear at/are at the root, at least one sibling of this member appears on the axis following zero or more descendants of the member. Type: Edm.Int32 Nullable: false |
DisplayInfoAbove |
This property contains various items of information that help an application render the axis, presuming children are expanded before their parent. The DisplayInfoAbove property contains various items of information that help an application render the axis, looking at the content of the axis in reverse order, useful in cases where children are presumed to be expanded before their parent/ancestors. It is a 4-byte value. The value of the least-significant byte of the least significant word contains the so called drill level. The drill level effectively represents the number of ancestors of a member that follow the member, hence those ancestors being drilled down, or rather up in this case, without breaking ancestry. The most significant byte of the least significant word represents the level in the ancestry relative to the ancestor at the root of the tree. In the most-significant 2 bytes, each bit potentially conveys one piece of display information, however for only 3 bits (the least-significant bits) a meaning has been defined. The least-significant bit (rightmost bit), if set, indicates that this member is drilled down, or up in this case. That is, at least one descendant of this member appears on the axis, immediately preceding all occurrences of that member. The next bit (the second least-significant bit), if set, indicates that the parent of this member is the same as the parent of the member following all occurrences of the current member. The last bit (the third least-significant bit), if set, indicates that, with the exception of members that appear at/are at the root, at least one sibling of this member appears on the axis preceding zero or more descendants of the member. Type: Edm.Int32 Nullable: false |
User
A user on a TM1 server.
Key: Name
Name | Details |
---|---|
Name |
The unique name of the user. Type: Edm.String Nullable: false |
FriendlyName |
The friendly name, also known as the display name, of the user. Added: 10.2.2.5 Type: Edm.String Nullable: false |
Password |
The password for the user. Type: Edm.String |
Type |
The type of the user. Added: 10.2.2.4 Type: tm1.UserType Nullable: false |
IsActive |
A Boolean that indicates whether the user is currently logged in to the TM1 server. Type: Edm.Boolean Nullable: false |
Enabled |
A Boolean that indicates whether the user is enabled. Added: 11.0.0 Type: Edm.Boolean Nullable: false |
Name | Details |
---|---|
Groups |
The defined groups that the user belongs to. A user can belong to multiple groups. Type: Collection(tm1.Group) Partner: Users |
Sessions |
The set of currently active sessions of this user. Added: 10.2.2.5 Type: Collection(tm1.Session) Partner: User |
View
A view of data in a cube.
Key: Name
Abstract: true
OpenType: true
Name | Details |
---|---|
Name |
The name of the view. Type: Edm.String Nullable: false |
Attributes |
The attributes of the view. Type: tm1.Attributes |
Name | Details |
---|---|
Cube |
The parent cube of the view. Type: tm1.Cube Nullable: false |
LocalizedAttributes |
Translated string values for properties of the view. Type: Collection(tm1.LocalizedAttributes) ContainsTarget: true |
ViewReference
A reference to a view.
Added: 10.2.2.1
BaseType: tm1.Entry
Name | Details |
---|---|
View |
The view that is referenced. Type: tm1.View |
Complex types
Complex types are structured types with a list of properties but with no key. Complex types can exist only as a property of a containing entity or as a temporary value.
AccessSettings
Added: 11.0.0
Name | Details |
---|---|
Network |
Type: tm1.NetworkSettings |
Authentication |
Type: tm1.AuthenticationSettings |
SSL |
Type: tm1.SSLSettings |
CAM |
Type: tm1.CAMSettings |
LDAP |
Type: tm1.LDAPSettings |
CAPI |
Type: tm1.CAPISettings |
HTTP |
Type: tm1.HTTPSettings |
AdministrationSettings
Added: 11.0.0
Name | Details |
---|---|
ServerName |
Type: Edm.String |
AdminHost |
Type: Edm.String |
Language |
Type: Edm.String |
DataBaseDirectory |
Type: Edm.String |
UnicodeUpperLowerCase |
Type: Edm.Boolean |
MaskUserNameInServerTools |
Type: Edm.Boolean |
AllowReadOnlyChoreReschedule |
Type: Edm.Boolean |
DisableSandboxing |
Type: Edm.Boolean |
RunningInBackground |
Type: Edm.Boolean |
StartupChores |
Type: Collection(Edm.String) |
PerformanceMonitorOn |
Type: Edm.Boolean |
PerfMonActive |
Type: Edm.Boolean |
EnableSandboxDimension |
Type: Edm.Boolean |
Clients |
Type: tm1.ClientSettings |
AuditLog |
Type: tm1.AuditLogSettings |
DebugLog |
Type: tm1.DebugLogSettings |
ServerLog |
Type: tm1.ServerLogSettings |
EventLog |
Type: tm1.EventLogSettings |
TopLog |
Type: tm1.TopLogSettings |
Java |
Type: tm1.JavaSettings |
ExternalDatabase |
Type: tm1.ExternalDatabaseSettings |
TM1Web |
Type: tm1.TM1WebSettings |
FileRetry |
Type: tm1.FileRetrySettings |
DownTime |
Type: Edm.String |
Attributes
OpenType: true
Name | Details |
---|---|
Caption |
Type: Edm.String |
AuditLogSettings
Added: 11.0.0
Name | Details |
---|---|
Enable |
Type: Edm.Boolean |
UpdateInterval |
Type: Edm.Duration |
MaxFileSizeKilobytes |
Type: Edm.Int64 |
MaxQueryMemoryKilobytes |
Type: Edm.Int64 |
AuthenticationSettings
Added: 11.0.0
Name | Details |
---|---|
SecurityPackageName |
Type: Edm.String |
ServicePrincipalName |
Type: Edm.String |
IntegratedSecurityMode |
Type: tm1.SecurityMode |
MaximumLoginAttempts |
Type: Edm.Int32 |
CAMSettings
Added: 11.0.0
Name | Details |
---|---|
CAMUseSSL |
Type: Edm.Boolean |
ClientURI |
Type: Edm.String |
ServerURIs |
Type: Collection(Edm.String) |
PortalVariableFile |
Type: Edm.String |
ClientPingCAMPassport |
Type: Edm.Int32 |
ServerCAMURIRetryAttempts |
Type: Edm.Int32 |
CreateNewCAMClients |
Type: Edm.Boolean |
CAPISettings
Added: 11.0.0
Name | Details |
---|---|
Port |
Type: Edm.Int32 |
ClientMessagePort |
Type: Edm.Int32 |
MessageCompression |
Type: Edm.Boolean |
ProgressMessage |
Type: Edm.Boolean |
ClientVersionMaximum |
Type: Edm.Int32 |
ClientVersionMinimum |
Type: Edm.Int32 |
ClientVersionPrecision |
Type: Edm.Int32 |
CalculationComponent
Added: 11.1.0
Name | Details |
---|---|
Type |
The type of calculation (consolidation or rule-driven) that populates this cell. Type: tm1.CalculationType |
Value |
The value of this cell. Type: Edm.PrimitiveType |
Statements |
The rule statement that populates this cell. Type: Collection(Edm.String) |
Components |
The set of components that determine the value of this cell. Type: Collection(tm1.CalculationComponent) |
Name | Details |
---|---|
Cube |
Cube containing the cell that is a component of the calculation. Type: tm1.Cube |
Tuple |
Coordinates of the cell that is a component of the calculation. Type: Collection(tm1.Element) |
CellDescriptor
Added: 10.2.2.1
Name | Details |
---|---|
Tuple |
Type: Collection(tm1.Element) |
CellsetUpdate
Contains the information necessary to perform a spread to a single cell.
The spreading command indicated by Value is applied to the cell specified by Tuple. Optionally, a reference cube and cell can also be specified.
Added: 11.0.0
Name | Details |
---|---|
Ordinal |
Type: Edm.Int64 Nullable: false |
Value |
Type: Edm.String Nullable: false |
Name | Details |
---|---|
ReferenceCube |
Type: tm1.Cube |
ReferenceCell |
Type: Collection(tm1.Element) |
ChoreTaskParameter
Added: 10.2.2.1
Name | Details |
---|---|
Name |
Type: Edm.String Nullable: false |
Value |
Type: Edm.PrimitiveType |
ClientSettings
Added: 11.0.0
Name | Details |
---|---|
PasswordMinimumLength |
Type: Edm.Int32 |
ClientPropertiesSyncInterval |
Type: Edm.Duration |
RetainNonCAMGroupMembership |
Type: Edm.Boolean |
CubeUpdate
Contains the information necessary to perform a spread to a single cell.
The spreading command indicated by Value is applied to the cell specified by Tuple. Optionally, a reference cube and cell can also be specified.
Added: 11.0.0
Name | Details |
---|---|
Value |
Type: Edm.String Nullable: false |
Name | Details |
---|---|
Tuple |
Type: Collection(tm1.Element) |
ReferenceCube |
Type: tm1.Cube |
ReferenceCell |
Type: Collection(tm1.Element) |
DebugLogSettings
Added: 11.0.0
Name | Details |
---|---|
LoggingDirectory |
Type: Edm.String |
DrillthroughRow
Added: 10.2.2.6
EventLogSettings
Added: 11.1.0
Name | Details |
---|---|
Enable |
Type: Edm.Boolean |
ScanFrequency |
Type: Edm.Duration |
ThresholdForThreadRunningTime |
Type: Edm.Duration |
ThresholdForThreadWaitingTime |
Type: Edm.Duration |
ThresholdForThreadBlockingNumber |
Type: Edm.Int32 |
ThresholdForPooledMemoryInMB |
Type: Edm.Int32 |
ExternalDatabaseSettings
Added: 11.0.0
Name | Details |
---|---|
OracleErrorForceRowStatus |
Type: tm1.OracleErrorForceRowStatus |
SQLFetchType |
Type: tm1.SQLFetchType |
SQLRowsetSize |
Type: Edm.Int32 |
ODBCLibraryPath |
Type: Edm.String |
TM1ConnectorforSAP |
Type: Edm.Boolean |
UseNewConnectorforSAP |
Type: Edm.Boolean |
ODBCTimeoutInSeconds |
Type: Edm.Int32 |
FedCellDescriptor
Added: 11.1.0
Name | Details |
---|---|
Fed |
Whether or not the cell is fed. Type: Edm.Boolean |
Name | Details |
---|---|
Cube |
Cube containing the cell. Type: tm1.Cube |
Tuple |
Coordinates of the cell. Type: Collection(tm1.Element) |
FeederTrace
Added: 11.1.0
Name | Details |
---|---|
FedCells |
Collection of cells that are fed by the source cell. Type: Collection(tm1.FedCellDescriptor) |
Statements |
Collection of feeder statements that have the source cell on the left hand side. Type: Collection(Edm.String) |
FileRetrySettings
Added: 11.0.0
Name | Details |
---|---|
FileRetryCount |
Type: Edm.Int32 |
FileRetryDelayMilliseconds |
Type: Edm.Int32 |
FileRetryFileSpec |
Type: Collection(Edm.String) |
Git
Added: 11.5.0
Name | Details |
---|---|
URL |
The URL of the remote Git repository. Type: Edm.String Nullable: false |
Deployment |
The deployment chosen for current Git operations. Type: Edm.String Nullable: false |
DeployedCommit |
The last commit of the source that is pulled to the server. Type: tm1.GitCommit Nullable: false |
Remote |
The information of the remote Git repository. Type: tm1.GitRemote Nullable: false |
GitCommit
Added: 11.5.0
Name | Details |
---|---|
ID |
The ID of the Git commit. Type: Edm.String Nullable: false |
Summary |
The summary of the Git commit. Type: Edm.String Nullable: false |
Author |
The author of the Git commit. Type: Edm.String Nullable: false |
GitRemote
Added: 11.5.0
Name | Details |
---|---|
Connected |
Indicates if the TM1 Server can connect to the remote Git repository. Type: Edm.Boolean Nullable: false |
Branches |
The branches in the remote Git repository. Type: Collection(Edm.String) |
Tags |
The tags in the remote Git repository. Type: Collection(Edm.String) |
HTTPSettings
Added: 11.0.0
Name | Details |
---|---|
Port |
Type: Edm.Int32 |
SessionTimeout |
Type: Edm.Duration |
JavaSettings
Added: 11.0.0
Name | Details |
---|---|
ClassPath |
Type: Edm.String |
JVMPath |
Type: Edm.String |
JVMArgs |
Type: Edm.String |
JobQueuingSettings
Added: 11.0.0
Name | Details |
---|---|
Enable |
Type: Edm.Boolean |
ThreadSleepTime |
Type: Edm.Duration |
ThreadPoolSize |
Type: Edm.Int32 |
MaxWaitTime |
Type: Edm.Duration |
LDAPSettings
Added: 11.0.0
Name | Details |
---|---|
Enable |
Type: Edm.Boolean |
Host |
Type: Edm.String |
Port |
Type: Edm.Int32 |
UseServerAccount |
Type: Edm.Boolean |
VerifyCertServerName |
Type: Collection(Edm.String) |
VerifyServerSSLCert |
Type: Edm.Boolean |
SkipSSLCertVerification |
Type: Edm.Boolean |
SkipSSLCRLVerification |
Type: Edm.Boolean |
WellKnownUserName |
Type: Edm.String |
PasswordFile |
Type: Edm.String |
PasswordKeyFile |
Type: Edm.String |
SearchBase |
Type: Edm.String |
SearchField |
Type: Edm.String |
LockingSettings
Added: 11.0.0
Name | Details |
---|---|
SubsetElementLockBreathing |
Type: Edm.Boolean |
UseLocalCopiesForPublicDynamicSubsets |
Type: Edm.Boolean |
PullInvalidationSubsets |
Type: Edm.Boolean |
MTQSettings
Added: 11.0.0
Name | Details |
---|---|
UseAllThreads |
Type: Edm.Boolean |
NumberOfThreadsToUse |
Type: Edm.Int32 |
SingleCellConsolidation |
Type: Edm.Boolean |
ImmediateCheckForSplit |
Type: Edm.Boolean |
OperationProgressCheckSkipLoopSize |
Type: Edm.Int64 |
MTFeeders |
Type: Edm.Boolean |
MTFeedersAtStartup |
Type: Edm.Boolean |
MemorySettings
Added: 11.0.0
Name | Details |
---|---|
ApplyMaximumViewSizeToEntireTransaction |
Type: Edm.Boolean |
DisableMemoryCache |
Type: Edm.Boolean |
CacheFriendlyMalloc |
Type: Edm.Boolean |
MaximumViewSizeMB |
Type: Edm.Int64 |
MaximumUserSandboxSizeMB |
Type: Edm.Int64 |
MaximumMemoryForSubsetUndoKB |
Type: Edm.Int64 |
LockPagesInMemory |
Type: Edm.Boolean |
ModellingSettings
Added: 11.0.0
Name | Details |
---|---|
MDXSelectCalculatedMemberInputs |
Type: Edm.Boolean |
DefaultMeasuresDimension |
Type: Edm.Boolean |
UserDefinedCalculations |
Type: Edm.Boolean |
EnableNewHierarchyCreation |
Type: Edm.Boolean |
Spreading |
Type: tm1.SpreadingSettings |
TI |
Type: tm1.TISettings |
Rules |
Type: tm1.RulesSettings |
Startup |
Type: tm1.StartupSettings |
Synchronization |
Type: tm1.SynchronizationSettings |
NameValuePair
Name | Details |
---|---|
Name |
Type: Edm.String Nullable: false |
Value |
Type: Edm.PrimitiveType |
NetworkSettings
Added: 11.0.0
Name | Details |
---|---|
IPAddress |
Type: Edm.String |
IPVersion |
Type: tm1.IPVersion |
NetRecvBlockingWaitLimit |
Type: Edm.Duration |
NetRecvMaxClientIOWaitWithinAPIs |
Type: Edm.Duration |
IdleConnectionTimeOut |
Type: Edm.Duration |
ReceiveProgressResponseTimeout |
Type: Edm.Duration |
PerformanceSettings
Added: 11.0.0
Name | Details |
---|---|
PrivilegeGenerationOptimization |
Type: Edm.Boolean |
Memory |
Type: tm1.MemorySettings |
MTQ |
Type: tm1.MTQSettings |
Locking |
Type: tm1.LockingSettings |
ViewCalculation |
Type: tm1.ViewCalculationSettings |
Stargate |
Type: tm1.StargateSettings |
JobQueuing |
Type: tm1.JobQueuingSettings |
ProcessDataSource
OpenType: true
Name | Details |
---|---|
Type |
Type: Edm.String Nullable: false |
ProcessDebugContextObjectLock
Added: 11.0.0
Name | Details |
---|---|
ObjectName |
Type: Edm.String Nullable: false |
ObjectType |
Type: Edm.String Nullable: false |
LockMode |
Type: tm1.ProcessDebugContextLockMode Nullable: false |
Scope |
Type: tm1.ProcessDebugContextObjectLockScope Nullable: false |
ProcessExecuteResult
A process execution return value.
Name | Details |
---|---|
ProcessExecuteStatusCode |
The status code return value. Type: tm1.ProcessExecuteStatusCode Nullable: false |
Name | Details |
---|---|
ErrorLogFile |
The error log for the process. Type: tm1.ErrorLogFile |
ProcessParameter
Name | Details |
---|---|
Name |
Type: Edm.String Nullable: false |
Prompt |
Type: Edm.String |
Value |
Type: Edm.PrimitiveType |
Type |
Type: tm1.ProcessVariableType Nullable: false |
ProcessSyntaxError
Added: 11.0.0
Name | Details |
---|---|
Procedure |
Type: tm1.ProcessProcedure Nullable: false |
LineNumber |
Type: Edm.Int32 Nullable: false |
Message |
Type: Edm.String Nullable: false |
ProcessVariable
Name | Details |
---|---|
Name |
Type: Edm.String Nullable: false |
Type |
Type: tm1.ProcessVariableType Nullable: false |
Position |
Type: Edm.Int32 |
StartByte |
Type: Edm.Int32 |
EndByte |
Type: Edm.Int32 |
RuleSyntaxError
Added: 11.1.0
Name | Details |
---|---|
LineNumber |
The number of the line containing the error. Type: Edm.Int32 |
Message |
The error message. Type: Edm.String |
RulesSettings
Added: 11.0.0
Name | Details |
---|---|
AllowSeparateNandCRules |
Type: Edm.Boolean |
AutomaticallyAddCubeDependencies |
Type: Edm.Boolean |
RulesOverwriteCellsOnLoad |
Type: Edm.Boolean |
ForceReevaluationOfFeedersForFedCellsOnDataChange |
Type: Edm.Boolean |
SSLSettings
Added: 11.0.0
Name | Details |
---|---|
Enable |
Type: Edm.Boolean |
ClientExportServerCertificate |
Type: Edm.Boolean |
CertificateID |
Type: Edm.String |
CertificateFile |
Type: Edm.String |
PrivateKeyPwdFile |
Type: Edm.String |
PwdKeyFile |
Type: Edm.String |
CertAuthority |
Type: Edm.String |
CertRevocationFile |
Type: Edm.String |
ClientExportServerKeyID |
Type: Edm.String |
KeyFile |
Type: Edm.String |
KeyStashFile |
Type: Edm.String |
KeyLabel |
Type: Edm.String |
TLSCipherList |
Type: Edm.String |
FIPSOperationMode |
Type: tm1.FIPSMode |
NIST_SP800_131A_MODE |
Type: Edm.Boolean |
ServerLogSettings
Added: 11.0.0
Name | Details |
---|---|
Enable |
Type: Edm.Boolean |
LogReleaseLineCount |
Type: Edm.Int32 |
SpreadingSettings
Added: 11.0.0
Name | Details |
---|---|
SpreadingPrecision |
Type: Edm.Double |
ProportionSpreadToZeroCells |
Type: Edm.Boolean |
StargateSettings
Added: 11.0.0
Name | Details |
---|---|
ZeroWeightOptimization |
Type: Edm.Boolean |
AllRuleCalcStargateOptimization |
Type: Edm.Boolean |
UseStargateForRules |
Type: Edm.Boolean |
StartupSettings
Added: 11.0.0
Name | Details |
---|---|
PersistentFeeders |
Type: Edm.Boolean |
MaximumCubeLoadThreads |
Type: Edm.Int32 |
LoadPrivateSubsetsOnStartup |
Type: Edm.Boolean |
SynchronizationSettings
Added: 11.0.0
Name | Details |
---|---|
SyncUnitSize |
Type: Edm.Int32 |
MaximumSynchAttempts |
Type: Edm.Int32 |
TISettings
Added: 11.0.0
Name | Details |
---|---|
CognosTM1InterfacePath |
Type: Edm.String |
UseExcelSerialDate |
Type: Edm.Boolean |
MaximumTILockObjects |
Type: Edm.Int32 |
EnableTIDebugging |
Type: Edm.Boolean |
TM1WebSettings
Added: 11.0.0
Name | Details |
---|---|
ExcelWebPublishEnabled |
Type: Edm.Boolean |
TopLogSettings
Added: 11.5.0
Name | Details |
---|---|
Enable |
Type: Edm.Boolean |
ScanMode |
Type: tm1.TopScanMode |
ScanFrequency |
Type: Edm.Duration |
ViewAxisSelection
Name | Details |
---|---|
Subset |
Type: tm1.Subset Nullable: false |
ViewCalculationSettings
Added: 11.0.0
Name | Details |
---|---|
MagnitudeDifferenceToBeZero |
Type: Edm.Int32 |
CheckFeedersMaximumCells |
Type: Edm.Int64 |
CalculationThresholdForStorage |
Type: Edm.Int64 |
ViewConsolidationOptimization |
Type: Edm.Boolean |
ViewConsolidationOptimizationMethod |
Type: Edm.String |
ViewTitle
Name | Details |
---|---|
Subset |
Type: tm1.Subset Nullable: false |
Selected |
Type: tm1.Element Nullable: false |
Enumerated types
Enumerated types are nominal types that represent a series of related values that are known as members.
AttributeType
Added: 10.2.2.1
Members:
- Numeric : 0
- String : 1
- Alias : 2
CalculationType
Added: 11.1.0
Members:
- Simple : 0
- Consolidation : 1
- Rule : 2
CellStatus
Members:
- Null : 0
- Data : 1
- Error : 2
ChoreExecutionMode
Added: 10.2.2.1
Members:
- SingleCommit : 0
- MultipleCommit : 1
ConflictResolution
Members:
- UsingSource : 0
- UsingTarget : 1
- Individually : 2
ElementType
Members:
- Numeric : 1
- String : 2
- Consolidated : 3
EncryptionFileType
Members:
- Object : 1
- TransactionLog : 2
- AuditLog : 3
FIPSMode
Added: 11.0.0
Members:
- FIPS_MODE : 1
- FIPS_APPROVED : 2
- FIPS_NONE : 3
GitPlanExecutionMode
Added: 11.5.0
Members:
- SingleCommit : 0
- MultipleCommit : 1
IPVersion
Added: 11.0.0
IsFlags: true
Members:
- IPv4 : 1
- IPv6 : 2
- Dual : 3
LogLevel
Added: 10.2.2.1
Members:
- Fatal : 0
- Error : 1
- Warning : 2
- Info : 3
- Debug : 4
- Unknown : 5
- Off : 6
MemberType
Members:
- Unknown : 0
- Regular : 1
- All : 2
- Measure : 3
- Formula : 4
OracleErrorForceRowStatus
Added: 11.0.0
Members:
- AutoDetect : 0
- Default : 1
- UseSQLULEN : 2
ProcessDebugContextHitMode
Added: 11.0.0
Members:
- BreakAlways : 0
- BreakEqual : 1
- BreakGreaterOrEqual : 2
ProcessDebugContextLockMode
Added: 11.0.0
IsFlags: true
Members:
- None : 0
- Read : 1
- ReadOnly : 2
- IntenteXclusiveNoCopy : 4
- IntenteXclusive : 8
- Write : 16
- Any : 31
ProcessDebugContextObjectLockScope
Added: 11.0.0
Members:
- Sandbox : 1
- Shared : 2
- Temporary : 3
A temporary lock scope that indicates a thread private object is not visible to other threads and will not cause contention with other threads.
ProcessDebugContextStatus
Added: 11.0.0
Members:
- Unknown : 0
- Running : 1
- Paused : 2
- Complete : 3
ProcessExecuteStatusCode
Added: 11.3.0
Members:
- CompletedSuccessfully : 0
- Aborted : 1
- HasMinorErrors : 2
- QuitCalled : 3
- CompletedWithMessages : 4
- RollbackCalled : 5
ProcessProcedure
Added: 11.0.0
Members:
- Prolog : 572
- Metadata : 573
- Data : 574
- Epilog : 575
ProcessVariableType
Members:
- String : 1
- Numeric : 2
SQLFetchType
Added: 11.0.0
Members:
- ExtendedFetch : 1
- FetchScroll : 2
- Fetch : 3
SecurityMode
Added: 11.0.0
Members:
- Basic : 1
- Integrated : 2
- Mixed : 3
- CAM : 4
ThreadType
Added: 10.2.2.1
Members:
- User : 0
- Worker : 1
- Chore : 2
- System : 3
TopScanMode
Added: 11.5.0
IsFlags: true
Members:
- Threads : 1
- Sandboxes : 2
- SandboxQueueMetrics : 4
UpdateOrder
Added: 11.0.0
Members:
- NoOrder : 0
- ByLevel : 1
UserType
Added: 10.2.2.4
Members:
- User : 0
- SecurityAdmin : 1
- DataAdmin : 2
- Admin : 3
- OperationsAdmin : 4
Added: 11.3.0
ViewConsolidationOptimizationMethod
Added: 11.0.0
Members:
- Tree : 0
- Array : 1