C Outline API Error Return Values

Table 7 describes the error status constants returned when an Outline API call fails. These values are defined in the Outline API C language header file esserror.h.

For a more complete list, see esserror.h.

Table 7. C Outline API Error Return Values

ValueDescription
OTLAPI_BAD_ALIASTABLEIllegal alias table
OTLAPI_BAD_CONSOLInvalid consolidation type (+,-,etc.)
OTLAPI_BAD_GENLEVELNAMEInvalid generation or level name
OTLAPI_BAD_HOUTLINEInvalid outline handle passed to EssOtl... function
OTLAPI_BAD_MBRNAMEInvalid member name
OTLAPI_BAD_MEMBERInvalid member handle
OTLAPI_BAD_MOVEIllegal move of member. Can't move member to its descendant.
OTLAPI_BAD_OBJTYPEIllegal object type
OTLAPI_BAD_OUTLINETYPEInvalid outline type
OTLAPI_BAD_PERSPECTIVE2Invalid perspective
OTLAPI_BAD_RENAMESHAREA shared member cannot be renamed
OTLAPI_BAD_RESTRUCTTYPEInvalid restructure type
OTLAPI_BAD_SCA_VALIDITYSET_TYPEPerspectives/validity sets do not support this validity set type
OTLAPI_BAD_SMARTLISTNAMEInvalid text list name
OTLAPI_BAD_SORT COMPAREFUNCInvalid sorting compare function
OTLAPI_BAD_SORTTYPEInvalid sort type
OTLAPI_BAD_TRANSTYPEUnknown transaction type when creating a transaction (internal error)
OTLAPI_BAD_USERATTRInvalid user attribute
OTLAPI_CUR_NOACCOUNTSThere is no Accounts dimension. You need an Accounts dimension to create a currency database.
OTLAPI_CUR_NOCOUNTRYThere is no Country dimension. You need a Country dimension to create a currency database.
OTLAPI_CUR_NOTIMEThere is no Time dimension. You need a Time dimension to create a currency database.
OTLAPI_ERR_ADDDELETEDIMDYNAMICCALCMember in which to store data is type Dynamic Calc
OTLAPI_ERR_ADDNAMEUSEDMember name already used (add operation)
OTLAPI_ERR_ALIASTABLEEXISTSAlias table already exists
OTLAPI_ERR_ALIASLANGUAGE_UNAVAILABLEAlias table languages are unavailable for outline versions before 11.1.2.0.00.
OTLAPI_ERR_ALIASTABLENAMEIllegal alias table name
OTLAPI_ERR_ALREADY CURRENCYThe outline is a currency outline. You are trying to create a currency outline, and the initial outline is already a currency outline.
OUTAPI_ERR_ASO_COMPRESSIONMUSTBEDYNAMICAggregate storage outlines require compression dimension to be a single dynamic hierarchy
OUTAPI_ERR_ASO_DIFFERENTNUMBEROFSHARESThis prototype should have same number of shared members as its previous sibling
OUTAPI_ERR_ASO_SHAREDMEMBERSNOTINSAMEORDERThis prototype must have each of its shared members as next sibling to its previous sibling's shared members
OTLAPI_ERR_ATTR_ATTACHED_WRONGLEVELThis attribute is attached at wrong level at least once
OTLAPI_ERR_ATTRMBR_ALREADYASSOCIATEDBase member already associated with an attribute member from the same dimension
OTLAPI_ERR_BADDIMInvalid dimension argument
OTLAPI_ERR_BADHIERInvalid hierarchy type
OTLAPI_ERR_BADHIER_TOPInvalid hierarchy member designation - Member must be at generation 1 or 2
OTLAPI_ERR_BADSHAREIllegal share value
OTLAPI_ERR_BADSKIPIllegal time balance skip value
OTLAPI_ERR_BADSTORAGEIllegal dimension storage value
OTLAPI_ERR_BADSTORAGECATEGORYIllegal storage category
OTLAPI_ERR_BADTIMEBALIllegal time balance value
OTLAPI_ERR_BSO_SOLVEORDERBlock storage outlines that have not been enabled for member types cannot have a solve order
OTLAPI_ERR_CANTIDENTIFYMBR_DUPLICATEDNAMECannot uniquely identify a member because the name is duplicated
OTLAPI_ERR_CNTS_INDEP_LASTIndependent dimension list must be ordered with continuous independent dimensions last
OTLAPI_ERR_CONFIGTOOMANYDIMSToo many dimensions to configure automatically
OTLAPI_ERR_COPYALIASTABLESource and destination tables are the same
OTLAPI_ERR_CREATETEMPCannot create temporary file name. You are probably trying to create it on a read-only drive. We create a temporary file on the client every time you open or write an outline from/to the server.
OTLAPI_ERR_CURTOOMANYDIMSToo many dimensions in a currency outline. A currency outline is limited to four dimensions.
OTLAPI_ERR_DELETEDEFALIASCannot delete the default alias table
OTLAPI_ERR_DISCRETE_DIFFERENTAn independent range must have the same discrete start and end members
OTLAPI_ERR_DISCRETE_OR_CNTSIndependent dimension types must be either discrete or continuous
OTLAPI_ERR_DUP_LANGCODEThe language code is assigned to another alias table within the same database
OTLAPI_ERR_DUPLICATEALIASDuplicate alias
OTLAPI_ERR_DUPLICATENAMEDuplicate member name
OTLAPI_ERR_DUPGENLEVNAMECannot add, rename, or set a member name or alias that duplicates a generation or level name
OTLAPI_ERR_EXPORT_INCORRECT_FLAGSThere are invalid export flags. Export cannot be enabled to limit extraction to the tree and alias table
OTLAPI_ERR_EXPORT_INVALID_ALIASTABLEAn invalid alias table is specified in the export options
OTLAPI_ERR_EXPORT_INVALID_DIMLISTThe number of dimensions or the dimension list specified in the export options is invalid
OTLAPI_ERR_EXPORT_INVALIDDIM_DIMLISTThe dimension name specified in the export options dimension list is invalid
OTLAPI_ERR_EXPORT_INVALID_VERSIONThis export version is invalid. Enter a valid export version
OTLAPI_ERR_EXPORT_UNABLE_FILECannot open the file to export the outline
OTLAPI_ERR_EXPORT_UNABLE_PROCESSCannot process the outline because of unsupported outline type
OTLAPI_ERR_FAILED_GET_ALIASNAMESFailed to get all alias names due to failed alias identifier lookup
OTLAPI_ERR_FEATURE_UNAVAILABLEThe feature is unavailable in this outline version; please migrate outline first
OTLAPI_ERR_FILEIOCould not read from or write to file
OTLAPI_ERR_FILEOPENCould not open file
OTLAPI_ERR_FORMATSTRING_MISMATCHImplied share or label-only member has a different format string than the original member; original member's format string will be applied
OTLAPI_ERR_FORMATSTRING_NOT_MEMBTYPE_ENABLEDThe use of format strings require the outline to be member-type enabled. This outline is not member type enabled
OTLAPI_ERR_FORMATSTRINGTOOLONGFormat String too long for single locale configuration
OTLAPI_ERR_FUNCTION_OBSOLETEFunction is obsolete
OTLAPI_ERR_GENLEVELEXISTSGeneration or level already has a name
OTLAPI_ERR_GENLEVELNAMEEXISTSGeneration or level name already exists
OTLAPI_ERR_GENLEVELVALUEIllegal generation or level value
OTLAPI_ERR_GENLEVNAMEMBRCannot add a generation or level name that duplicates a member name or alias
OTLAPI_ERR_ILLEGALALIAS STRINGIllegal member combinational for alias
OTLAPI_ERR_ILLEGALCOMBOALIASIllegal combinational alias name
OTLAPI_ERR_ILLEGALCURRENCYIllegal currency member
OTLAPI_ERR_ILLEGALDEFALIASIllegal default alias name
OTLAPI_ERR_ILLEGALNAMEIllegal member name
OTLAPI_ERR_ILLEGALTAGIllegal dimension tag (category)
OTLAPI_ERR_ILLEGALOPTIONOccurs when the user passes in an invalid option to EssOtlGetGenNames() or EssOtlGetLevelNames()
OTLAPI_ERR_IMPLIED_SHARE_OLD_VERSIONThe outline version is too old to set Implied Share
OTLAPI_ERR_INCORRECT_MEMBERTYPEMember type can be only set to numeric or date types
OTLAPI_ERR_INVALID_SMARTLIST_HANDLEInvalid text list handle
OTLAPI_ERR_INVALID_SMARTLIST_IMPORTFILEInput file for importing text lists is invalid
OTLAPI_ERR_INVALIDID_SMARTLIST_IMPORTFILEInvalid or duplicate ID in text list import file
OTLAPI_ERR_LANGCODE_TOOLONGAlias table language code exceeds the maximum length
OTLAPI_ERR_LEAFLABELLeaf member defined as a label member
OTLAPI_ERR_MAXALIASTABLESMaximum number of alias tables has been reached
OTLAPI_ERR_MEMBERCALCIllegal member formula
OTLAPI_ERR_MEMBERTYPE_OFFCannot turn off the member type enabled setting of an outline
OTLAPI_ERR_MBRCOMMENTEXLENExtended member comment is too long
OTLAPI_ERR_MISSINGTEXT_SMARTLIST_IMPORTFILEMissing text for ID in text list import file
OTLAPI_ERR_MULT_DATE_DIMSAn outline can have at most one dimension with date types on static members
OTLAPI_ERR_MULTIHIER_NOT_ENABLEDCannot set hierarchy type; multiple hierarchies not enabled for dimension
OTLAPI_ERR_MULT_SMARTLIST_DIMSAn outline can have at most one dimension with smartlists on static members
OTLAPI_ERR_MUSTSAVE_BEFORE_EDITThe outline must be saved and re-opened before it can be edited
OTLAPI_ERR_NOALIASNo alias for this member
OTLAPI_ERR_NOALIASCODEGet/Set alias table language code is not yet implemented
OTLAPI_ERR_NOALIASCOMBONo alias combination
OTLAPI_ERR_NOATTRONCOMPRESSEDDIMAttributes are not allowed on the compressed dimension
OTLAPI_ERR_NOFORMULANo formula for this member
OUTAPI_ERR_NOMEMBTYPEThis outline version does not support typed members
OTLAPI_ERR_NOSHAREPROTOShared member with no actual member
OUTAPI_ERR_NOSMARTLISTSThis outline version does not support text lists
OTLAPI_ERR_NOTADIMDimension name expected
OTLAPI_ERR_NOT_A_TIME_MBRInvalid argument passed. Not a date-time dimension member
OTLAPI_ERR_NOT_LINKEDATTRIBUTEDIMNot a linked attribute dimension handle
OTLAPI_ERR_NOT_MEMBTYPE_ENABLEDThis outline is not member type enabled
OTLAPI_ERR_NOTIMEDIMNo time dimension defined (can't do time balance operations without a time dimension)
OTLAPI_ERR_NOTVERIFIEDOutline has errors (when saving to the server)
OTLAPI_ERR_OBJ_NOTFOUNDObject not found
OTLAPI_ERR_OBJTYPE_NOTSUPPORTEDFunction not supported in server side edit mode
OTLAPI_ERR_OPENMODEFile was opened in the wrong mode to make this call. If you call EssOtlOpenOutlineQuery() to open the outline, not all of the calls will work.
OTLAPI_ERR_OTLDATEFORMATInvalid outline property: date format
OTLAPI_ERR_OTLSHARED_FORMATOutline member's format string cannot be set for shared members
OTLAPI_ERR_OTLSHARED_TYPEOutline member's type cannot be set for shared members
OTLAPI_ERR_QUERYHINT_INVALIDARRAYSIZEInvalid query hint array size
OTLAPI_ERR_RENAMEDEFALIASCannot rename the default alias table
OTLAPI_ERR_RENAMENAMEUSEDMember name already used (rename operation)
OTLAPI_ERR_SCA_NOT_ENABLEDThis outline is not enabled for varying attributes
OTLAPI_ERR_SCA_UNAVAILABLEVarying attributes feature is unavailable in this version
OTLAPI_ERR_SHAREDMEMBERFORMULAShared member cannot have a formula
OTLAPI_ERR_SHARENOTLEVEL0Shared member not at level 0 (a shared member cannot be a parent of another member)
OTLAPI_ERR_SHAREUDACannot set a user attribute for a shared member
OTLAPI_ERR_SMARTLISTNAMEUSEDCannot add text list; text list name already used
OTLAPI_ERR_SMARTLIST_MAPMAXREACHEDCannot add more than n text list texts to id mappings
OTLAPI_ERR_SMARTLISTMAXREACHEDCannot add text list; n maximum text lists supported
OTLAPI_ERR_SMARTLIST_MISSINGMissing text list association for text-typed member
OTLAPI_ERR_TBTAGS_WITH_DYN_HIERARCHYThis member has a TB-Tag. That requires TIME dimension to only have STORED hierarchies
OTLAPI_ERR_TIMESPARSEAccounts dimension is dense and time dimension sparse-is not used
OTLAPI_ERR_TYPED_ATTR_LEVEL0Attribute members and non level-0 aggregate storage members cannot be set to Date or Text type
OTLAPI_ERR_TYPED_DIMSText typed members, date typed members, and stored members with format strings should be specified along the same dimension
OTLAPI_ERR_UNKNOWNDTSMBRUnknown DTS member
OTLAPI_ERR_VALIDITYSET_MATCHThe validity set must match an existing set in the outline
OTLAPI_ERR_VIRTLEV0NOFORMULADynamic Calc members must have formulas or children, or else they cannot be calculated
OTLAPI_ERR_VIRTBADPARENTWhen a single child member is Dynamic Calc or Dynamic Calc and Store, the parent must also be Dynamic Calc or Dynamic Calc and Store
OTLAPI_ERR_VIRTTOOMANYCHILDRENDynamic Calc member has more than 100 children
OTLAPI_FAILED_ASSIGN_DEFAULTGENNAMESFailed to set time related generation names for the date-time dimension created
OTLAPI_ILLEGAL_SCA_TYPE_2Varying attribute outlines do not allow duplicate names, and cannot be a currency outline
OTLAPI_INVALID_ARGInvalid argument passed to ESSOTL function
OTLAPI_INVALID_QUERYIDInvalid query id argument passed
OTLAPI_INVALID_QUERY_OPTIONSInvalid query options passed. Will be ignored
OTLAPI_NO_GENLEVELNAMECannot find generation or level name
OTLAPI_NO_USERATTRCannot find user attribute
OTLAPI_NULL_ARGNULL argument passed to EssOtl... function
OTLAPI_OUTLINE_TOO_NEWOutline is of a newer version than this program can understand
OTLAPI_SORT_TOOMANYToo many members to sort (64K / 4 members is the maximum sorting capacity)
OTLAPI_SMARTLIST_ASSOC_EXISTSCannot delete a text list with existing associations
OTLAPI_SMARTLIST_DUP_IDORNAMEDuplicate text list element ID or name
OTLAPI_SMARTLIST_INVALID_TEXTInvalid text list text
OTLAPI_WRONG_INDEPDIM_NMThe number of independent dimensions given in perspective does not match the outline