Entitäten

Die Entitäten beschreiben die Kernobjekte von open bi. Sie können sowohl über die APIs, als auch über die Desktop- und Web-Konfiguratoren angelegt, angezeigt, geändert und gelöscht werden.

Diese Dokumentation erläutert den Zweck jeder Entität und die zur Verfügung stehenden Standardfelder. Wie alle anderen technischen Documentationen ist sie ausschließlich in Englisch verfügbar.

Zur Philiosophie von open bi gehört aber auch die Erweiterbarkeit der Entitäten. Über Tabellenattribute lassen sich auf einfache Weise projektspezifische Attribute hinzufügen. Besuchen Sie hierzu die Kategorie "Modelling" des open bi Blogs.

User

The user entity controls, who is allowed to login to open bi using the open bi Configurators, the CMS orthe API.

Database Table

USERS

Standard Delivery

Element
Description
Property
admin
Description
Unrestricted access

Entry Properties

Field
Documentation
Field
User name
BARUSER
Documentation
The user name for logginig in
Field
Password
Documentation
The password for logging in
Field
Initial password
INITIALPWD
Documentation
When active, open bi asks for changing the initially set password. The message is displayed while logging in until the password has been changed
Field
Active
ACTIVE
Documentation
The user is allowed to logon only if this field is activated.
Field
Salutation
SALUT
Documentation
Field
First name
FIRSTNAME
Documentation
Field
Last name
LASTNAME
Documentation
Field
Picture
PROFILEPICTURE
Documentation
Avatar as binary
Field
Birthday
BIRTHDAY
Documentation
Field
Street
STRASSE
Documentation
Field
Postal Code
PLZ
Documentation
Field
City
ORT
Documentation
Field
Country
COUNTRY
Documentation
Field
Email
MAIL
Documentation
Field
Phone
PHONE
Documentation
Field
Mobile
MOBILE
Documentation
Field
Fax
FAX
Documentation
Field
Company
COMPANY
Documentation
Field
Department
DEPARTMENT
Documentation
Field
Supervisor
SUPERIOR
Documentation
Reference to another user entity
Field
Function
FUNCTIONS
Documentation
Field
Group
GROUP
Documentation
Field
Location
LOCATION
Documentation
Field
Room
ROOM
Documentation
Field
Invalid logons counter
INVALID_LOGON_ATTEMPTS
Documentation
Read only
Field
Last invalid logon
LAST_INVALID_LOGON
Documentation
Read only
Field
Last password change
LAST_PASSWORD_CHANGE
Documentation
Read only
Field
Registration date
SIGNUPDATE
Documentation
Read only

References

Entity
Reference Detail
Entity
Organisation
USERORGAASSIGNMENT
Reference Detail
The user can be assigned to one or more organisations, in order to centrally define authorization and settings
Entity
User Group
USERUSERGROUPASSIGNMENT
Reference Detail
One or more user groups control user's access to data and functions
Entity
Role
USERROLEASSIGNMENT
Reference Detail
One or more roles can be used to provide access to data or a CMS navigation

User Group

The user group entity controls access to role elements and functions. Also see Data Authorization.

Database Table

USERGROUPS

Standard Delivery

Property
Description
Property
Administrator
Description
Unrestricted access
Property
User Administrator
Description
Access to the user, organisation, user group entities
Property
Role Administrator
Description
Access to the role entity
Property
Portal Administrator
Description
Access to the blog entity
Property
Content Administrator
Description
Joins the authorization of User Administrator with Portal Administrator and Role Administrator, adds access to custom entities
Property
Connection Administrator
Description
Access to the connection template entity
Property
Batch Job Administrator
Description
Access to the batch jobs

Properties

Field
Documentation
Field
Id
ID
Documentation
Read only
Field
Name
NAME
Documentation
Field
Description
DESCRPTION
Documentation
Entity
Reference Detail
Entity
Organisation
USERGROUPSTOORGA
Reference Detail
Organisations assigned to the user group
Entity
User
USERUSERGROUPASSIGNMENT
Reference Detail
Users assigned to the user group
Entity
Role Content
ROLECONTENTUSERGROUPS
Reference Detail
Role Content assigned to this user group

Organisation

Can be used to create tenant based CMS sites and to manage central authorizations.

Database Table

ORGANISATION

Properties

Field
Documentation
Field
Id
ID
Documentation
Read only
Field
Name
ORGUNIT
Documentation
Field
Description
DESCRIPTION
Documentation
Field
Address
ADDRESS
Documentation
Field
Postal Conde
PLZ
Documentation
Field
City
CITY
Documentation
Field
Country
COUNTRY
Documentation
Field
Additional Info
ADDITIONALINFO
Documentation
Custom use
Field
Additional Info
ADDITIONALINFO2
Documentation
Custom use
Field
Customer Number
CUSTOMERNR
Documentation
Custom use
Field
Code ID
CODEID
Documentation
Custom use
Field
Registration ID
REGISTRATIONCODE
Documentation
Custom use
Field
Mail
EMAIL
Documentation
Field
Phone
PHONE
Documentation
Field
Fax
FAX
Documentation
Field
Website
WEBSITE
Documentation
Field
Host Header
HOST_HEADER
Documentation
Reference to a Host Header to define the tenant for the organisation
Field
CMS Host
CAMPAIGN_URL
Documentation
Alternative to referencing a host header: Enter the Url here, which shall show the CMS of this organisation
Field
CMS Role
CMS_ROLE
Documentation
Alternative to referencing a host header: Reference to a Role that defines the CMS structure
Field
CMS Page
ENTRY_PAGE
Documentation
Alternative to referencing a host header: Reference the CMS master page directly

References

Entity
Reference Detail
Entity
Role
USERROLEASSIGNMENT
Reference Detail
Roles can be assigned to provide central access to data and documents
Entity
User
USERORGAASSIGNMENT
Reference Detail
Users can be assigned to a organisation, in order to centrally define authorization and data access
Entity
User Group
USERGROUPSTOORGA
Reference Detail
User Groups can controll authorization centrally

Role

Tree like structure for storing information such as favourites, files, dataproviders and CMS sites.

Database Table

ROLES

Properties

Field
Documentation
Field
Id
ROLEID
Documentation
Read only
Field
Name
NAME
Documentation
Field
Description
DESCRIPTION
Documentation
Field
Type
TYPE
Documentation
The type of the role: Favourite, Data, CMS, Assets, Documents
Field
Creation Date
CREATED
Documentation
Read only
Field
Creator
BARUSER
Reference to a user that created the role
Read only

References

Entity
Reference Detail
Entity
User
USERROLEASSIGNMENT
Reference Detail
Roles can be assigned to a user to provide access to data
Entity
Organisation
USERROLEASSIGNMENT
Reference Detail
Roles can be assigned to an organisation to provide access to data
Entity
Reference Detail
The Role Elements in a tree structure

Role Element

Single elements of the role tree.

Database Table

ELEMENTS

Properties

Field
Documentation
Field
Id
ID
Documentation
Read only
Field
Language
LANGUAGE
Documentation
Field
Name
NAME
Documentation
Field
Type
TYPE
Documentation
File, Page, Dataprovider
Field
File name
FILENAME
Documentation
For files: Contains the file name
Field
Extension
EXTENSION
Documentation
For files: Contains the file extension
Field
Binary Content
BINCONTENT
Documentation
Contains binary data such as files
Field
Text Content
ASCIICONTENT
Documentation
Contains text data such as XML dataprovider information
Field
conatains binary content
ISBIN
Documentation
Indicator if binary or text content is provided
Field
Creation Date
CREATED
Documentation
Read only
Field
Changed Date
CHANGED
Documentation
Read only
Field
Creator
BARUSER
Reference to a user that created the role
Read only

References

Entity
Reference Detail
Entity
Reference Detail
Brings the Role Elements in a tree structure

Role Content

Defines the nodes in the role tree and user group authorizations.

Database Table

ROLECONTENT

Properties

Field
Documentation
Field
Id
ID
Documentation
Reference to a role element
Field
Role Id
ROLEID
Documentation
Assignment to the role
Field
Parent
PARENT
Documentation
The parent element. Empty for the root node.
Field
is folder
ISFOLDER
Documentation
Indicates whether the node is a folder or a role element
Field
Name
NAME
Documentation
For files: Contains the file name
Field
Type
TYPE
Documentation
Folder, File, Page, Dataprovider
Field
Position
POSITION
Documentation
Position of the element under the parent node.

References

Entity
Reference Detail
Entity
User Group Assignment
ROLECONTENTUSERGROUPS
Reference Detail
Multiple user groups can be assigned to a node in the role tree.

Host Header

Host Headers are used for the CMS to define which domain displays a specific CMS role content.

Database Table

HOST_HEADER

Properties

Field
Documentation
Field
Id
ID
Documentation
Read only
Field
Host
URL
Documentation
Enter the Url here, which shall show the CMS
Field
Role
CMS_ROLE
Documentation
Reference to a Role that defines the CMS structure
Field
Page
ENTRY_PAGE
Documentation
Reference to a CMS master page
Field
Require SSL
REQUIRE_SSL
Documentation
If activated, the CMS is only accessible via https

Connection Template

Connection Templates define a connection to a 3rd party system.

Database Table

CONNECTION_TEMPLATE

Properties

Field
Documentation
Field
Id
ID
Documentation
Read only
Field
Name
NAME
Documentation
Field
Description
DESCRIPTION
Documentation
Field
Dataprovider Type
DATAPROVIDER_TYPE
Documentation
The Type of the dataprovider: SAP BW, Database, Flatfile, etc.
Field
Hidden
HIDDEN
Documentation
If activated, the connection is hidden from the UI. It is only available for access via HTML Items or the API

References

For a connection, a list of name - value pairs defines the parameters needed to establish the connection.

Database Table: CONNECTION_TEMPLATE_PARAMETER

Field
Documentation
Field
Parameters
CONNECTION_TEMPLATE
Documentation
Reference to the Connection Template
Field
Name
NAME
Documentation
Field
Id
ID
Documentation
Read only
Field
Value
VALUE
Documentation
Field
Type
TYPE
Documentation
String, Password, Integer, Boolean
Field
Supplied
SUPPLIED
Documentation
If not activated, the parameter will automatically be visible on the logon UI when establishing a connection.
Field
Position
POSITION
Documentation
The position of the parameter on the logon UI

Batch Job

A batch job defines a specific automation process that shall be triggered at a certain point in time.

Database Table

JOBS

Properties

Field
Documentation
Field
Id
ID
Documentation
Read only
Field
Name
NAME
Documentation
The name of the schedule
Field
Active
ACTIVE
Documentation
Field
Batch Handler
HANDLER
Documentation
The class inheritating from BatchHandlerBase that handles the background execution
Field
Job Type
JOBTYPE
Documentation
Event based ("E") or calendar based ("S").
Field
Periodic
PERIODIC
Documentation
If not activated, the job will only run once.
Field
Periodic Type
PERIODIC_TYPE
Documentation
For calendar based schedules: Minutely ("M"), Hourly ("H"), Daily ("D"), Weekly ("W"), Monthly ("MO"), Yearly ("Y")
Field
Period Gap
PERIODIC_VALUE
Documentation
The "gap" between executions. "2" in combination will "weekly" will execute the schedule biweekly
Field
Start date and time
START
Documentation
Field
End date and time
END
Documentation
Field
Event name
EVENTNAME
Documentation
Custom event
Field
Event value
EVENTVALUE
Documentation
Custom event
Field
Last run
LASTRUN
Documentation
Read only
Field
User
USER
Documentation
Read only

References

For a job, a list of name - value pairs defines the parameters that can control the behaviour of the batch handler.

Database Table: JOBPARAM

Field
Documentation
Field
Parameters
JOBID
Documentation
Reference to the Job
Field
Id
ID
Documentation
Read only
Field
Name
NAME
Documentation
Field
Value
VALUE
Documentation
Field
Position
POSITION
Documentation

Transport Task

A Transport Tasks contains a list of elements that shall be jointly published to another instance of open bi.

Database Table

TRANSPORT_TASK

Properties

Field
Documentation
Field
Id
ID
Documentation
Read only
Field
Description
DESCRIPTION
Documentation
Field
Created by
OWNER
Documentation
Read only
Field
Creation Date
CREATED
Documentation
Read only
Field
Last Change Date
CHANGED
Documentation
Read only
Field
Release Date
RELEASED
Documentation
Read only
Field
Release state
STATE
Documentation
Read only - "OPEN" / "CLOSED" / "TRANSPORTED"
Field
Source open bi instance
SOURCE
Documentation
Read only

References

A transport task consists of a list of transport elements that shall be transported jointly.

Database Table: TRANSPORT_TASK_ELEMENT

Blog

A blog collects a list of blog posts for the open bi CMS.

Database Table

SPCONTENTBOOKS

Properties

Field
Documentation
Field
Id
ID
Documentation
Read only
Field
Name
TITLE
Documentation
Field
Description
DESCRIPTION
Documentation
Field
Type
TYPE
Documentation

References

A list of blog posts are collected in a blog.

Database Table: SPCONTENTARTICLES

Field
Documentation
Field
Id
ID
Documentation
Read only
Field
Blog Id
BOOKID
Documentation
Reference to the Blog
Field
Name
TITLE
Documentation
Field
Headline
HEADLINE
Field
Content
CONTENT
Documentation
The HTML markup for the blog post
Field
Url Path
URL
Documentation
The URL path with which the post shall be published
Field
Position
ORDER
Documentation
Field
Author
AUTHOR
Documentation
Reference to a User
Field
Creation Date
CREATED
Documentation
Field
Changed Date
MODIFIED
Documentation

Custom entity

With Custom entities you can model additional custom objects within open bi. The Custom entity is created with some standard fields and can be enhanced using Table Attributes, just like standard entities.

open bi generates a database table for the entity, which can then be filled manually or via a data upload.

Database Table

SHOP_PRODUCT

Properties

Field
Documentation
Field
Id
ID
Documentation
Used to generate the table name.
Field
Name
NAME
Documentation
The name of the Custom entity
Field
Database Table
PRODUCT_TABLE
Documentation
Read only. The table that was generated for the entity. Concatenated from "SHOP_PRODUCT_" and the ID
Field
Description
DESCRIPTION
Documentation
The description of the object to be modeled with the entity
Field
Creation Date
CREATED
Documentation
Read only
Field
Changed Date
CHANGED
Documentation
Read only

Table Attribute

A Table Attribute adds a custom field to a standard open bi or custom entity.

Database Table

TABLEATTRIBUTES

Properties

Field
Documentation
Field
Id
ID
Documentation
Read only
Field
Table
TABLE
Documentation
The name of the database table to be enhanced
Field
Field name
NAME
Documentation
The name of the field to be added
Field
Type
TYPE
Documentation
"STRING" / "BOOLEAN" / "INTEGER" / "DOUBLE" / "DATETIME"
Field
Length
LENGTH
Documentation
Field
Default value
DEFAULTVALUE
Documentation
Field
Multiple Values
IS_MULTIPLE
Documentation
Field
Exclusive usage
EXCLUSIVE
Documentation

Data Authorization

Whereas User Groups control authorization for role elements and features, the Data Authorization can limit access to certain views of one object.

Database Table

AUTHOBJECT

Properties

Field
Documentation
Field
Id
AUTHOBJECT
Documentation
Read only
Field
Dimension
DIMID
Documentation
The Id of the dimension in the data model.
Field
Description
DESCRIPTION
Documentation

References

A list of selections the data authorization is authorizing the user.

Database Table: AUTHVALUES

Field
Documentation
Field
Id
AUTHVALUEID
Documentation
Read only
Field
Authorization Object
AUTHOBJECT
Documentation
Reference to the Data Authorization
Field
Sign
SIGN
Documentation
(I)nclude or (E)xclude
Field
Option
OPT
Equals (EQ), Between (BT), Greater Than (GT), Lower Than (LT)
Field
Low Value
LOW
Documentation
The authorized value. "*" authorizes for all values.
Field
High Value
HIGH
Documentation
The "to" part of the interval, if option BT is used
Field
Owner
OWNER
Documentation
Reference to User or Organization that is authorized.

Inquiry

An inquiry, e.g. by a potential lead from the website.

Database Table

INQUIRIES

Properties

Field
Documentation
Field
Id
INQUIRYID
Documentation
Read only
Field
Inquirer Id
INQUIRERID
Documentation
Reference to the inquirer
Field
User
USER
Documentation
Field
Date
DATE
Documentation
Field
Status
STATUS
Documentation
Field
Message
COMMENTS
Documentation
Field
Host
HOST
Documentation
Field
Path
PATH
Documentation
Field
Url
URL
Documentation

References

The inquirer to an inquiry.

Database Table: INQUIRER

Field
Documentation
Field
Id
INQUIRERID
Documentation
Read only
Field
Salutation
SALUTATION
Documentation
Reference to the Data Authorization
Field
First name
FIRSTNAME
Documentation
Field
Last Name
LASTNAME
Field
Street
STREET
Documentation
Field
Postal Code
ZIPCODE
Documentation
Field
City
CITY
Documentation
Field
Country
COUNTRY
Documentation
Field
Phone
PHONE
Documentation
Field
Fax
FAX
Documentation
Field
Mobile
MOBILE
Documentation
Field
Email
EMAIL
Documentation
Field
Web
WEB
Documentation
Field
Comment
COMMENT
Documentation
Field
Company
COMPANY
Documentation
Field
Type
TYPE
Documentation