2022 April Release

Software Component FSCMINDBREEZE@1.1001 Permanent link for this heading

Classes Permanent link for this heading

Component

Reference

Description

FSCMINDBREEZE@1.1001

ConfigObject

Mindbreeze Configuration

FSCMINDBREEZE@1.1001

MBInSpireService

Mindbreeze InSpire Service

FSCMINDBREEZE@1.1001

PortalSearch

Search

FSCMINDBREEZE@1.1001

SavedSearch

Saved Search

Properties Permanent link for this heading

Type

Property

Name

MenuRoot

classmbctxmenu

Mindbreeze Client Context Menu

MenuAssignment[]

classmbctxmenuex

Mindbreeze Client Context Menus

boolean

createserviceuser

Create Service User

AttributeDefinition

criterionproperty

Property

boolean

defaultcriterion

Set as a Standard Criteria for My Search

MBInSpireService[]

fldmbinspiresvcs

Mindbreeze InSpire Services

boolean

fscmbabstract

Abstract

boolean

fscmbaggregatable

Aggregatable (Available as Filter in Facets)

boolean

fscmballattrs

All Properties

User

fscmbapiuser

User With Access to Integration Web Service

APIUser

fscmbapiusersettings

User With Access to Integration Web Service

AuthenticationParams

fscmbauthentication

Authentication

AuthenticationType

fscmbauthtype

Type

Content[]

fscmbcacertcontents

Root and Intermediate Certificate Authorities

Certificate[]

fscmbcacerts

Root and Intermediate Certificate Authorities

string

fscmbcategory

Category

content

fscmbcert

Certificate

string

fscmbcertkeypwd

Private Key Password

string

fscmbcloudkey

Fabasoft Cloud Key

string[]

fscmbconstraint

Constraint

ContentAttrDescList[]

fscmbcontentattrdesc

Property Description

AttributeDefinition[]

fscmbcontentattrpath

Property Path

ContentMappingList[]

fscmbcontentmappings

Mappings for Contents

boolean

fscmbenablemetadatafulltextsearch

Enable Metadata Full Text Search

boolean

fscmbextlist

As List

boolean

fscmbextnarrow

Narrow

string

fscmbextref

External Reference

boolean

fscmbextwiden

Widen

boolean

fscmbfeedbacksuccessful

Sent Feedback Successfully

FilterService

fscmbfltsrv

Filter Service

string

fscmbfltsrvurl

Filter Service URL

boolean

fscmbgenerateextref

Generate External References

Group

fscmbgroup

Group

MBInspireServiceSettingsType

fscmbinspirefeedbacksvc

Mindbreeze InSpire Service for Feedbacks

string

fscmbinspirekey

Mindbreeze InSpire Key

MBInSpireService

fscmbinspiresvc

Mindbreeze InSpire Service

MBInSpireServiceConfig[]

fscmbinspiresvcconfigs

Mindbreeze InSpire Services Configuration

MBInSpireService[]

fscmbinspiresvcs

Mindbreeze InSpire Services

MBInspireServiceSettingsType

fscmbinspiretrainingdatasvc

Mindbreeze InSpire Service for Training Data

MBKeyMapping[]

fscmbkeymapping

Key Mapping

string[]

fscmbkeyprefixes

Software Component Prefixes for the Mapping of Fabasoft Cloud Keys

dictionary

fscmbmetadata

Categorization

boolean

fscmbnoaccget

Do Not Consider Access Types for Search

NotSearchableClassList[]

fscmbnotsearchable

Object Classes Not Searchable

Object

fscmbobject

Object for Name and Icon

ObjectAttrDescList[]

fscmbobjectattrdesc

Property Description

AttributeDefinition[]

fscmbobjectattrpath

Property Path

ObjectClass

fscmbobjectclass

Object Class

ObjectMappingList[]

fscmbobjectmappings

Mappings for Metadata

string

fscmbpassword

Password

string

fscmbportalwebclientsvcurl

Web Client Service URL (Portal-Search)

string

fscmbproject

Project

boolean

fscmbqsresultoverlay

Show Quick Search Result In Overlay

QueryConstraintList[]

fscmbqueryconstraints

Predefined Constraints

boolean

fscmbregistered

Registered

App[]

fscmbrequiredapps

Required Apps

string

fscmbscope

Scope

boolean

fscmbsendfeedback

Send Feedback to Mindbreeze InSpire Service

SoftwareComponent

fscmbsoftwarecomponent

Software Component

ComponentObject[]

fscmbsvccontexts

Contexts Required

string

fscmbtenant

Tenant

boolean

fscmbusedomainconstraints

Use Domain Constraints

boolean

fscmbuseinspirefeedbacksvc

Own Mindbreeze InSpire Service for Feedbacks

boolean

fscmbuseinspiretrainingdatasvc

Own Mindbreeze InSpire Service for Training Data

string

fscmbuser

User Name

boolean

fscmbusescopeconstraints

Use Scope Constraints

string

fscmbwebclientsvcurl

Web Client Service URL (Embedded-Search)

ConfigObject

fscmindbreezecfg

Mindbreeze

MBInSpireService[]

grmbinspiresvcs

Mindbreeze InSpire Services

MBCategorizationData

objmbcategorization

Mindbreeze Categorization

string[]

objmbjsonannotations

PDF Annotations (InstantJSON)

string

objmbviewcategorization

Mindbreeze Categorization (JSON)

Object

overwritesavedsearch

Overwrite existing search query

PortalSearch

portalsearch

Search

PortalSearchData

portalsearchdata

Search Input

Object[]

savedsearches

Saved Search Queries

QuerySaveMode

savemode

Save As

string

savename

Name

Object

savetarget

Save To

string

sdconstraint

Content of Query Data "constraint"

Object

sdcontextobject

Context Object

string

sdqueryconstraintid

Query Constraint ID

boolean

sdrequiresfacetpropsdefinitions

Requires Backend-Defined Facets

string

sduser

Content of Query Data "user"

SearchData

searchdata

Search Data

boolean

TV_ISMESCONTEXT

Evaluation of the Mindbreeze Client Context Information

string

TV_MESKEY

MES Key

AttributeDefinition[]

usrsetcriterionproperties

User Criterion Properties

SavedSearch[]

usrsetfavsavedsearches

Saved Search Queries (favored)

SavedSearch[]

usrsetsavedsearches

Saved Search Queries

Actions Permanent link for this heading

Return Type

Signature

void

AddCriterion(
  optional integer unused1,
  optional integer unused2)

void

ApplyMBCategorization()

void

AttrFldMbInSpireServiceGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

void

AttrFldMbInSpireServiceSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

void

ChangeDefaultMBInSpireService(
  optional integer unused1,
  optional integer unused2)

void

ChangeDefaultMBInSpireServiceSelected(
  optional integer unused1,
  optional integer unused2)

void

CheckContentConvert(
  string srctype,
  string desttype,
  optional string progid,
  optional string auxparam,
  ref optional dictionary globalscope)

integer[]

CheckIndexKeys(
  string[] keylist,
  out retval integer[] actionlist,
  optional integer timeout,
  optional boolean contentaccess)

void

ConvertContent(
  optional string srctype,
  optional string desttype,
  content srccont,
  ref content destcont,
  optional interface tool,
  optional string printer,
  ref optional dictionary globalscope)

void

CreateCredentials()

void

CreateMBInSpireService(
  optional integer unused1,
  optional integer unused2)

OAuthToken

CreateToken(
  optional string srvurl,
  optional string clientid,
  optional string clientsecret,
  out retval OAuthToken authtoken)

void

DeleteSavedSearchQuery(
  optional integer unused1,
  optional integer unused2)

boolean

DoShowPortalSearchMenu(
  object context,
  out retval boolean doshow)

object

FindObjectByExternalKey(
  string extkey,
  AttributeDefinition attrdef,
  out retval object obj)

void

FurtherSavedSearchQueries(
  optional integer unused1,
  optional integer unused2)

string

GetAccessToken(
  string privatekey,
  string target,
  out retval string token,
  optional boolean forcerefresh,
  out optional boolean refreshed)

void

GetAllowedClasses(
  out object[] allowed,
  out object[] notallowed)

dictionary

GetCategorization(
  object object,
  optional Content content,
  ref optional retval dictionary metadata,
  optional CategorizationType type)

void

GetContentMapping(
  out ContentMappingList[] mappings)

MBInSpireService

GetDefaultMBInSpireService(
  out retval MBInSpireService svc,
  optional object context)

string

GetFscKey(
  string mbkey,
  out retval string fsckey)

string[]

GetFTSObjectContext(
  out retval string[] grantcontext,
  out string[] denycontext)

void

GetFTSQueryContext(
  out string[] context)

MBInSpireService

GetMBInSpireService(
  out retval MBInSpireService svc,
  optional object context)

string

GetMBKey(
  string fsckey,
  out retval string mbkey)

dictionary

GetMetadataByKey(
  object context,
  ref string mbkey,
  ref string fsckey,
  optional MBCategorizationData categorization,
  out retval dictionary value)

object[]

GetObjectClassMapping(
  out retval object[] classes)

object

GetObjectFromValue(
  object sourceobj,
  any value,
  AttributeDefinition attrdef,
  out retval object obj)

void

GetObjectMapping(
  out ObjectMappingList[] mappings,
  out boolean enablemetadatafulltextsearch,
  out boolean generateextref)

MBInSpireService[]

GetPossibleMBInSpireServices(
  out retval MBInSpireService[] inspiresvcs)

boolean

IsPortalSearchEnabled(
  out retval boolean isenabled)

void

MapKeys(
  ref string mbkey,
  ref string fsckey)

void

MarkSavedSearchQueryAsFavorite(
  optional integer unused1,
  optional integer unused2)

MBCategorizationData

MBCategorize(
  optional object srcobj,
  optional Content srccontent,
  out retval MBCategorizationData categorization,
  optional object context)

void

MBSendCategorizationFeedback(
  optional object feedbackfor,
  optional Content content)

content

ProtoBufURL(
  content request,
  out retval content response)

dictionary

PutCategorization(
  CategorizationType type,
  optional object object,
  optional Content content,
  ref optional retval dictionary metadata)

void

RefreshToken(
  ref OAuthToken authtoken)

void

ResetSearch(
  optional integer unused1,
  optional integer unused2)

void

SaveSearchQuery(
  optional integer unused1,
  optional integer unused2)

void

SearchFacet(
  boolean hideportalpart)

void

UnmarkSavedSearchQueryAsFavorite(
  optional integer unused1,
  optional integer unused2)

void

ValidateApp(
  string apptype,
  out boolean valid,
  out string redirecturl)

void

ValidateSession(
  ApplicationType apptype,
  out boolean valid,
  out string redirecturl)

void

ViewHit()

void

ViewPreview()

Types Permanent link for this heading

Component

Reference

Description

FSCMINDBREEZE@1.1001

APIUser

Defines the user with access to the Mindbreeze integration web service

FSCMINDBREEZE@1.1001

ApplicationType

FSCMINDBREEZE@1.1001

AuthenticationParams

Defines the authentication parameters

FSCMINDBREEZE@1.1001

AuthenticationType

Defines the Mindbreeze InSpire authentication type

FSCMINDBREEZE@1.1001

CategorizationType

Defines the categorization type that determines how the Mindbreeze Filter Service processes

FSCMINDBREEZE@1.1001

ContentAttrDescList

FSCMINDBREEZE@1.1001

ContentMappingList

FSCMINDBREEZE@1.1001

MBCategorizationData

Defines the Mindbreeze categorization data

FSCMINDBREEZE@1.1001

MBInSpireServiceConfig

Defines the structure for configuring a Mindbreeze InSpire service via the configure mechanism

FSCMINDBREEZE@1.1001

MBInspireServiceSettingsType

Type for configuring a dedicated Mindbreeze Inspire service

FSCMINDBREEZE@1.1001

MBKeyMapping

Defines the key mapping between Mindbreeze InSpire and the Fabasoft Cloud

FSCMINDBREEZE@1.1001

NotSearchableClassList

FSCMINDBREEZE@1.1001

ObjectAttrDescList

FSCMINDBREEZE@1.1001

ObjectMappingList

FSCMINDBREEZE@1.1001

QueryConstraintList

Defines the list of predefined query constraints

FSCMINDBREEZE@1.1001

QuerySaveMode

Enum containing information where to save a Mindbreeze search query

FSCMINDBREEZE@1.1001

SearchData

Type for the saved Mindbreeze search query data

FSCMINDBREEZE@1.1001

TransactionVariable

Applications Permanent link for this heading

Component

Reference

Description

FSCMINDBREEZE@1.1001

GroupCreateMBInSpireService

FSCMINDBREEZE@1.1001

MBInSpireServiceChangeDefaultMBInSpireService

FSCMINDBREEZE@1.1001

ObjectResetSearch

FSCMINDBREEZE@1.1001

ObjectSearchFacet

ErrorMessages Permanent link for this heading

Component

Reference

Description

FSCMINDBREEZE@1.1001

ERR_INVALIDINSPIRECONFIG

Invalid InSpire service configuration: An external key is required

FSCMINDBREEZE@1.1001

ERR_INVSERVICE

The requested Protocol Buffers service "%1$s" is not supported.

FSCMINDBREEZE@1.1001

ERR_INVSERVICEMETHOD

The requested Protocol Buffers method "%2$s" of service "%1$s" is not supported.

FSCMINDBREEZE@1.1001

ERR_PROTOBUFPARSE

Could not parse Protocol Buffers message.

FSCMINDBREEZE@1.1001

ERR_PROTOBUFSERIALIZE

Could not serialize Protocol Buffers message.

FSCMINDBREEZE@1.1001

ERR_RESTORESEARCHQUERYFAILURE

An error occured, the search query could not be restored.

FSCMINDBREEZE@1.1001

ERR_SAVESEARCHQUERYFAILURE

An error occured, the search query could not be saved.

FSCMINDBREEZE@1.1001

ERR_TOKENMISSING

Token is missing ("%1$s").

FSCMINDBREEZE@1.1001

WARN_NOTSEARCHABLE

The property "%2$s" mapped to the object class "%1$s" is not searchable due to its access types for reading.

FormPages Permanent link for this heading

Component

Reference

Description

FSCMINDBREEZE@1.1001

PageAddCriterion

FSCMINDBREEZE@1.1001

PageExploreMindbreezeSearchResult

FSCMINDBREEZE@1.1001

PageMBInSpireService

FSCMINDBREEZE@1.1001

PageReadMindbreezeSearchResult

FSCMINDBREEZE@1.1001

PageSaveSearchQuery

FSCMINDBREEZE@1.1001

PageSearchPortalExplore

FSCMINDBREEZE@1.1001

PageSearchPortalWidgetView

FSCMINDBREEZE@1.1001

PageSelectSavedSearchQuery

Menus Permanent link for this heading

Component

Reference

Description

FSCMINDBREEZE@1.1001

MenuAddCriterion

Add Criterion

FSCMINDBREEZE@1.1001

MenuChangeDefaultMBInSpireService

Set as Default

FSCMINDBREEZE@1.1001

MenuCreateMBInSpireService

Create Mindbreeze InSpire Service

FSCMINDBREEZE@1.1001

MenuDeleteSavedSearchQuery

Delete

FSCMINDBREEZE@1.1001

MenuFurtherSavedSearchQueries

Further Saved Search Queries

FSCMINDBREEZE@1.1001

MenuMarkSavedSearchQueryAsFavorite

Add to Favorites

FSCMINDBREEZE@1.1001

MenuResetSearch

Reset Search

FSCMINDBREEZE@1.1001

MenuSavedSearchQueries

Saved Search Queries

FSCMINDBREEZE@1.1001

MenuSaveSearchQuery

Save Search Query

FSCMINDBREEZE@1.1001

MenuUnmarkSavedSearchQueryAsFavorite

Remove from Favorites

ObjectEditForms Permanent link for this heading

Component

Reference

Description

FSCMINDBREEZE@1.1001

FormAddCriterion

FSCMINDBREEZE@1.1001

FormExploreMindbreezeSearchResult

FSCMINDBREEZE@1.1001

FormMBInSpireService

FSCMINDBREEZE@1.1001

FormMBInSpireServiceCtor

FSCMINDBREEZE@1.1001

FormReadMindbreezeSearchResult

FSCMINDBREEZE@1.1001

FormSaveSearchQuery

FSCMINDBREEZE@1.1001

FormSearchPortalExplore

FSCMINDBREEZE@1.1001

FormSearchPortalProperties

FSCMINDBREEZE@1.1001

FormSearchPortalWidgetView

FSCMINDBREEZE@1.1001

FormSelectSavedSearchQuery

SimpleConfigurationObjects Permanent link for this heading

Component

Reference

Description

FSCMINDBREEZE@1.1001

MindbreezeDefaultConfig

FSCMINDBREEZE@1.1001

PageSearchFacet

Search Facet

Strings Permanent link for this heading

Component

Reference

Description

FSCMINDBREEZE@1.1001

STR_NARROW

Narrow to "%s"

FSCMINDBREEZE@1.1001

STR_NARROWEX

Narrow to "%1$s" with "%2$s" as "%3$s"

FSCMINDBREEZE@1.1001

STR_WIDEN

Widen to "%s"

FSCMINDBREEZE@1.1001

STR_WIDENEX

All hits of "%1$s" with "%2$s" as "%3$s"

FSCMINDBREEZE@1.1001

StrChangeDefaultMBInSpireService

Do you want to define "%1$s" as default "%2$s" for "%3$s"?

FSCMINDBREEZE@1.1001

StrDefaultInSpireService

Default Mindbreeze InSpire Service

FSCMINDBREEZE@1.1001

StrPersonalSettings

Personal Settings

FSCMINDBREEZE@1.1001

StrYouCanRunSavedSearchQueryAgain

You can run saved search queries again.

FSCMINDBREEZE@1.1001

StrYouCanRunThisSavedSearchQueryAgain

You can run this saved search queries again.