Like what you see? Have a play with our trial version.

Error rendering macro 'rw-search'

null

Versions Compared

Old Version 7

changes.mady.by.user user-3484a

Saved on

compared with

New Version 8

changes.mady.by.user user-3484a

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleAdministrationPerson

This object is used to define a Yellowfin user involved in a function.

 

AdministrationPerson Element

Data Type

Description

UserId

String

User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method.

Password

String

Password of the Yellowfin user.

FirstName

String

First name of of the Yellowfin user.

LastName

String

Last name of of the Yellowfin user.

Initial

String

Middle initial of the Yellowfin user.

SalutationCode

String

Title of the Yellowfin user. Possible values include:

  • DR
  • MISS
  • MR
  • MRS
  • MS

RoleCode

String

Yellowfin role. The specified role here can be the Org Reference Code (YFADMIN) or the name of the role (Yellowfin Administrator).

EmailAddress

String

Email address of the Yellowfin user.

LanguageCode

String

Two letter code for the preferred language.

IpId

Integer

Internal Yellowfin IP ID.

TimeZoneCode

String

The TimeZoneCode of the Yellowfin user.

Status

String

User status. One of

  • ACTIVE
  • INACTIVE
  • INACTIVEWITHEMAIL

 

 

Anchor
AdminGroup
AdminGroup

Expand
titleAdministrationGroup

These are the parameters for the AdministrationGroup object:

 

 

AdministrationGroup Element

Data Type

Description

GroupName

String

 Name of a group.

GroupDescription

String

 Description of a group.

GroupId

Integer

 Unique ID to identify a group.

GroupStatus

String

 

GroupInternalReference

String

 

GroupMembers

AdministrationGroupMember[]

An array of AdministrationGroupMember objects. These objects hold group member metadata

 

 

Anchor
AdminGroupMember
AdminGroupMember

Expand
titleAdministrationGroupMember
Parameter NameData TypeDescription
InternalIdIntegerThis is the IpId field of Person table in the Yellowfin database.
LoginIdStringUser ID of the group member (depending on the Logon ID method, this could be the email address or user ID).

 

 

 

 

 

Expand
titleAdministrationReport

AdministrationReport Element

Data Type

ReportName

String

ReportDescription

String

ReportId

Integer

ExecutionObject

String

ReportCategory

String

ReportSubCategory

String

BirtData

String

SourceName

String

SourceId

Integer

AuthoringMode

String

ReportTemplate

String

DataOutput

String

DashboardEnabled

Boolean

ViewId

Integer

ViewName

String

ViewDescription

String

LastModifierName

String

LastModifierId

Integer

LastModifiedDate

Date

PublishDate

Date

DeliveryMode

String

LastRunTime

Integer

AverageRunTime

Integer

RoleCode

String

ChartTypeCode

String

AdministrationReportGroup Element

Data Type

Description

ReportGroupName

String

 

ReportGroupDescription

String

 

Usage

Integer

 

 

Expand
titleAdministrationReportGroup

ReportGroupId

Integer

 

ReportGroupStatus

String

ReportGroupType

String

 

...

ReportGroupInternalReference

...

String

 

...

GroupReports

...

 

 

Array of AdministrationReport objects which hold report metadata. These are the reports that make up the portlets within the dashboard tab

AssociatedReports

Array (Integer)

 

Expand
titleAdministrationRole

AdministrationReportGroup Element

Data Type

Description

RoleName

String

The name of the Yellowfin role

RoleDescription

String

The business description of the Yellowfin role

RoleCode

String

The internal code for the Yellowfin role that is generated and referenced in the database

 

 

Expand
titleAdministrationGroup

AdministrationGroup Element

Data Type

Description

GroupName

String

 

GroupDescription

String

 

GroupId

Integer

 

GroupStatus

String

 

GroupInternalReference

String

 

GroupMembers

Array (AdministrationGroupMember)

An array of AdministrationGroupMember objects. These objects hold group member metadata

 

 

Expand
titleAdministrationClientOrg

AdministrationClientOrg Element

Data Type

Description

ClientName

String

Name of the client organisation

ClientReferenceID

String

Client Reference ID which is the unique ID used to identify a client

TimeZoneCode

String

A client organisation’s local time zone code. See appendix for valid values.

DefaultOrg

Boolean

Boolean value that returns true if this organisation is the primary organisation

 

 

...