• API
Show / Hide Table of Contents
  • BiExcellence.OpenBi.Api
    • IOpenBiConfiguration
    • IOpenBiRequest
    • IOpenBiRequestSerializable
    • IOpenBiResponse
    • IOpenBiServerMessage
    • IOpenBiSession
    • IOpenBiSessionHttpClient
    • MessageCategory
    • OpenBiConfiguration
    • OpenBiConfigurationExtensions
    • OpenBiErrorEventArgs
    • OpenBiRequestEventArgs
    • OpenBiRequestExtensions
    • OpenBiResponseCodes
    • OpenBiResponseEventArgs
    • OpenBiServerErrorException
    • OpenBiSession
    • OpenBiSessionExtensions
    • Protocol
    • SecureOpenBiSession
  • BiExcellence.OpenBi.Api.Commands
    • ContentTypes
    • Filter
    • FilterOperator
    • FilterSign
    • HierarchyNode<T>
    • IFilter
    • IListRequest
    • IListRequest<T>
    • IListResponse
    • IListResponse<T>
    • ILoginInfo
    • IPingInfo
    • ISessionInfo
    • ListRequestExtensions
    • OpenBiLoginExtensions
    • OpenBiPingExtensions
  • BiExcellence.OpenBi.Api.Commands.AuthObjects
    • AuthObject
    • AuthObjectValue
    • IAuthObject
    • IAuthObjectValue
    • OpenBiAuthObjectExtensions
  • BiExcellence.OpenBi.Api.Commands.AuthObjects.Internal
    • AuthObjectJsonImpl
    • AuthObjectValueJsonImpl
  • BiExcellence.OpenBi.Api.Commands.BatchJobs
    • BatchJob
    • BatchJobHandlerParameterType
    • BatchJobParameter
    • BatchJobPeriodicType
    • BatchJobType
    • IBatchJob
    • IBatchJobHandler
    • IBatchJobHandlerParameter
    • IBatchJobLog
    • IBatchJobLogEntry
    • IBatchJobParameter
    • OpenBiBatchJobExtensions
    • OpenBiConfigurationExtensions
  • BiExcellence.OpenBi.Api.Commands.BatchJobs.Internal
    • BatchJobJsonImpl
    • BatchJobParameterJsonImpl
  • BiExcellence.OpenBi.Api.Commands.Blogs
    • Blog
    • BlogArticle
    • IBlog
    • IBlogArticle
    • OpenBiBlogExtensions
  • BiExcellence.OpenBi.Api.Commands.Blogs.Internal
    • BlogArticleJsonImpl
    • BlogJsonImpl
  • BiExcellence.OpenBi.Api.Commands.Cms
    • CmsItemAttributeTypes
    • CmsItemTemplate
    • ICmsItem
    • ICmsItemAttribute
    • ICmsItemDefinition
    • ICmsItemReplacementParameter
    • ICmsItemTemplate
    • ICmsItemTemplateHistory
    • OpenBiCmsExtensions
  • BiExcellence.OpenBi.Api.Commands.Cms.Internal
    • CmsItemTemplateJsonImpl
  • BiExcellence.OpenBi.Api.Commands.Configurator
    • IObjectLock
    • IServerError
    • ITransportTask
    • ITransportTaskElement
    • OpenBiEmailExtensions
    • OpenBiObjectLockExtensions
    • OpenBiServerErrorExtensions
    • OpenBiTransportTaskExtensions
    • TransportTask
    • TransportTaskElement
    • TransportTaskElementActions
    • TransportTaskElementTypes
    • TransportTaskStates
  • BiExcellence.OpenBi.Api.Commands.ConnectionTemplates
    • ConnectionTemplate
    • ConnectionTemplateParameter
    • ConnectionTemplateParameterType
    • DataProviderTypes
    • IConnection
    • IConnectionTemplate
    • IConnectionTemplateParameter
    • IDataProviderType
    • OpenBiConnectionExtensions
    • OpenBiConnectionTemplateExtensions
    • OpenBiRequestExtensions
  • BiExcellence.OpenBi.Api.Commands.ConnectionTemplates.Internal
    • ConnectionTemplateJsonImpl
    • ConnectionTemplateParameterJsonImpl
  • BiExcellence.OpenBi.Api.Commands.DataProviders
    • AffectedDataProvider
    • AffectedDataProviderMode
    • AlertLevel
    • AlertLevelId
    • ChartDataExtensions
    • DataProvider
    • DataProviderCubeType
    • DataProviderDefinition
    • DataProviderExtensions
    • DataProviderRoleType
    • DataProviderView
    • DataProviderViewExtensions
    • DataVisualType
    • Dimension
    • DimensionAxis
    • DimensionSortType
    • DimensionSumState
    • DrillState
    • DrillStateTuple
    • DrillStateValue
    • F4ValueExtensions
    • GridCellContent
    • GridDefinitionEventArgs
    • GridExtensions
    • IAffectedDataProvider
    • IAffectedDataProviderExecuteDefinition
    • IAlertLevel
    • IChartCategory
    • IChartCategoryGroup
    • IChartData
    • IChartGroup
    • IChartPoint
    • IDataComment
    • IDataProvider
    • IDataProviderDefinition
    • IDataProviderNode
    • IDataProviderView
    • IDimension
    • IDimensionAttribute
    • IDimensionAttributes
    • IDimensionGridCell
    • IDimensionHierarchy
    • IDimensions
    • IDrillState
    • IDrillStates
    • IDrillStateTuple
    • IExecuteDefinition
    • IExportDocument
    • IF4Value
    • IF4Values
    • IFilterableInfoObject
    • IFlatF4Value
    • IGrid
    • IGridCell
    • IGridCell<T>
    • IGridData
    • IGridDefinition
    • IHierarchyF4Value
    • IInfoObject
    • IInfoObjects<T>
    • IKeyFigure
    • IKeyFigures
    • InfoObjectDataType
    • InfoObjectsExtensions
    • InfoObjectSortMode
    • IPositionableInfoObject<T>
    • IPositionableInfoObjects<T>
    • ISortableInfoObject
    • ISortTuple
    • ISumGridCell
    • ITuple
    • IUsedConnection
    • IUsedConnections
    • IValueGridCell
    • IVariable
    • IVariables
    • KeyFigure
    • KeyFigureAggregation
    • KeyFigureCalculationTime
    • KeyFigureExtensions
    • OpenBiDataProviderExtensions
    • OpenBiDataProviderViewExtensions
    • OpenBiRequestExtensions
    • SortTuple
    • Variable
    • VariableEntryType
    • VariableSelection
    • VariableType
  • BiExcellence.OpenBi.Api.Commands.DataProviders.Internal
    • DataProviderDefinitionJsonImpl
    • DataProviderUtils
  • BiExcellence.OpenBi.Api.Commands.DatastoreObjects
    • DatastoreObject
    • DatastoreObjectTypes
    • IDatastoreObject
    • OpenBiDatastoreObjectExtensions
  • BiExcellence.OpenBi.Api.Commands.DatastoreObjects.Internal
    • DatastoreObjectJsonImpl
  • BiExcellence.OpenBi.Api.Commands.Downloads
    • Download
    • IDownload
    • OpenBiDownloadExtensions
  • BiExcellence.OpenBi.Api.Commands.Downloads.Internal
    • DownloadJsonImpl
  • BiExcellence.OpenBi.Api.Commands.Entities
    • BaseEntity
    • Entity
    • IBaseEntity
    • IBaseEntityAssignment
    • IEntity
    • OpenBiEntityExtensions
  • BiExcellence.OpenBi.Api.Commands.Entities.Internal
    • BaseEntityJsonImpl
    • EntityJsonImpl
  • BiExcellence.OpenBi.Api.Commands.Files
    • OpenBiSessionFileExtensions
  • BiExcellence.OpenBi.Api.Commands.HostHeaders
    • HostHeader
    • IHostHeader
    • OpenBiHostHeaderExtensions
  • BiExcellence.OpenBi.Api.Commands.HostHeaders.Internal
    • HostHeaderJsonImpl
  • BiExcellence.OpenBi.Api.Commands.Inquiries
    • IInquirer
    • IInquiry
    • IInquiryField
    • OpenBiInquirerExtensions
    • OpenBiInquiryExtensions
  • BiExcellence.OpenBi.Api.Commands.LanguageTexts
    • ILanguageText
    • ILanguageTextValue
    • LanguageText
    • LanguageTextValue
    • OpenBiLanguageTextExtensions
  • BiExcellence.OpenBi.Api.Commands.LanguageTexts.Internal
    • LanguageTextJsonImpl
    • LanguageTextValueJsonImpl
  • BiExcellence.OpenBi.Api.Commands.LicenseInformation
    • ILicenseInformation
    • ILicenseInformationComponent
    • OpenBiLicenseInformationExtensions
  • BiExcellence.OpenBi.Api.Commands.MajaAi
    • IMajaEntity
    • IMajaGrammar
    • IMajaQueryAnswer
    • IMajaTalent
    • IMajaTalentCategory
    • IPossibleUserReply
    • MajaQueryAnswerAction
    • MajaQueryAnswerProposalType
    • News
    • OpenBiMajaExtensions
    • PossibleUserReplyControlType
    • PossibleUserReplyType
    • WeatherDetails
    • WeatherForecast
  • BiExcellence.OpenBi.Api.Commands.MajaAi.Internal
    • MajaGrammarJsonImpl
    • MajaTalentCategoryJsonImpl
    • MajaTalentJsonImpl
  • BiExcellence.OpenBi.Api.Commands.MapDimensions
    • IMapDimension
    • MapDimension
    • OpenBiMapDimensionExtensions
  • BiExcellence.OpenBi.Api.Commands.MapDimensions.Internal
    • MapDimensionJsonImpl
  • BiExcellence.OpenBi.Api.Commands.MasterData
    • IMasterData
    • IMasterDataAttribute
    • IMasterDataAttributes
    • IMasterDataHierarchy
    • IMasterDataHierarchyMemberNode
    • IMasterDataHierarchyNode
    • IMasterDataHierarchyTextNode
    • MasterData
    • MasterDataAttribute
    • MasterDataAttributes
    • MasterDataHierarchy
    • MasterDataHierarchyMemberNode
    • MasterDataHierarchyNodeExtensions
    • MasterDataHierarchyTextNode
    • OpenBiMasterDataExtensions
  • BiExcellence.OpenBi.Api.Commands.Organisations
    • IOrganisation
    • OpenBiOrganisationExtensions
    • Organisation
  • BiExcellence.OpenBi.Api.Commands.Organisations.Internal
    • OrganisationJsonImpl
  • BiExcellence.OpenBi.Api.Commands.RoleContents
    • IRoleContent
    • IRoleContentElement
    • IRoleContentElementCmsContent
    • IRoleContentElementHistory
    • IRoleContentHistory
    • OpenBiRoleContentExtensions
    • RoleContent
    • RoleContentElement
    • RoleContentElementCmsContent
    • RoleContentExtensions
  • BiExcellence.OpenBi.Api.Commands.Roles
    • IRole
    • IRoleAssignment
    • OpenBiRoleExtensions
    • Role
  • BiExcellence.OpenBi.Api.Commands.Roles.Internal
    • RoleAssignmentJsonImpl
    • RoleJsonImpl
  • BiExcellence.OpenBi.Api.Commands.ServerSettings
    • IServerSettingParameter
    • IServerSettingParameters
    • IServerSettings
    • OpenBiServerSettingsExtensions
    • ServerSettingParameter
  • BiExcellence.OpenBi.Api.Commands.TableAttributes
    • BooleanTableAttribute
    • DateTimeTableAttribute
    • DoubleTableAttribute
    • ICustomAttributes
    • IntegerTableAttribute
    • ITableAttribute
    • ITableAttribute<T>
    • ITableAttributeCache
    • ITableAttributes
    • ITableAttributes<T>
    • OpenBiTableAttributeExtensions
    • StringTableAttribute
    • TableAttribute
    • TableAttributeAttribute
    • TableAttributes
    • TableAttributes<T>
  • BiExcellence.OpenBi.Api.Commands.TableAttributes.Internal
    • TableAttributeJsonImpl
    • TableAttributeUtils
  • BiExcellence.OpenBi.Api.Commands.Usergroups
    • IUsergroup
    • IUsergroupAssignment
    • OpenBiUsergroupExtensions
    • Usergroup
  • BiExcellence.OpenBi.Api.Commands.Usergroups.Internal
    • UsergroupAssignmentJsonImpl
    • UsergroupJsonImpl
  • BiExcellence.OpenBi.Api.Commands.Users
    • IUser
    • OpenBiUserExtensions
    • User
  • BiExcellence.OpenBi.Api.Commands.Users.Internal
    • UserJsonImpl
  • BiExcellence.OpenBi.Api.Internal
    • ApiFieldAttribute
    • EnumValueAttribute
    • Utils

Class ConnectionTemplate

Represents a connection template.

Inheritance
object
ConnectionTemplate
ConnectionTemplateJsonImpl
Implements
  • IConnectionTemplate
  • IDataProviderType
  • ICustomAttributes
Namespace: BiExcellence.OpenBi.Api.Commands.ConnectionTemplates
Assembly: BiExcellence.OpenBi.Api.DataProvider.dll
Syntax
public class ConnectionTemplate : IConnectionTemplate, IDataProviderType, ICustomAttributes

Constructors

ConnectionTemplate()

Initializes a new instance of the ConnectionTemplate class with a new id.

Declaration
public ConnectionTemplate()

ConnectionTemplate(IConnectionTemplate)

Copy constructor.

Declaration
public ConnectionTemplate(IConnectionTemplate connectionTemplate)
Parameters
Type Name Description
IConnectionTemplate connectionTemplate

ConnectionTemplate(IDataProviderType)

Copy constructor.

Declaration
public ConnectionTemplate(IDataProviderType dataProviderType)
Parameters
Type Name Description
IDataProviderType dataProviderType

The data provider type.

ConnectionTemplate(string)

Initializes a new instance of the ConnectionTemplate class.

Declaration
public ConnectionTemplate(string id)
Parameters
Type Name Description
string id

The id.

Properties

CustomAttributes

Gets or sets the custom attributes.

Declaration
public IDictionary<string, object?> CustomAttributes { get; set; }
Property Value
Type Description
IDictionary<string, object>

DataProviderType

Gets or sets the data provider type.

Declaration
public string? DataProviderType { get; set; }
Property Value
Type Description
string

Description

Gets or sets the description.

Declaration
public string? Description { get; set; }
Property Value
Type Description
string

Id

Gets the id.

Declaration
public string Id { get; protected set; }
Property Value
Type Description
string

IsHidden

Gets or sets whether the data provider type is hidden.

Declaration
public bool IsHidden { get; set; }
Property Value
Type Description
bool

Name

Gets or sets the name.

Declaration
public string? Name { get; set; }
Property Value
Type Description
string

Parameters

Gets the connection template parameters.

Declaration
public IList<IConnectionTemplateParameter> Parameters { get; }
Property Value
Type Description
IList<IConnectionTemplateParameter>

Methods

ToString()

Returns the Name.

Declaration
public override string? ToString()
Returns
Type Description
string
Overrides
object.ToString()

Implements

  • IConnectionTemplate
  • IDataProviderType
  • ICustomAttributes

Extension Methods

  • Utils.FireEvent<T>(object, string, T)
  • Utils.FireEvent<T>(object, string, object, T)
In This Article
Back to top bi excellence software GmbH