arlas-wui-toolkit / Exports / ArlasStartupService

Class: ArlasStartupService

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new ArlasStartupService(settingsService, configService, collaborativesearchService, injector, fetchOptions, getOptions, http, translateService, configUpdater, persistenceService, permissionService, errorService, fetchInterceptorService, arlasIamService, arlasAuthService, processService)

Parameters

Name Type
settingsService ArlasSettingsService
configService ArlasConfigService
collaborativesearchService ArlasCollaborativesearchService
injector Injector
fetchOptions any
getOptions any
http HttpClient
translateService TranslateService
configUpdater any
persistenceService PersistenceService
permissionService PermissionService
errorService ErrorService
fetchInterceptorService FetchInterceptorService
arlasIamService ArlasIamService
arlasAuthService ArlasAuthentificationService
processService ProcessService

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:186

Properties

analytics

• analytics: AnalyticGroupConfiguration[]

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:173

arlasExploreApi

• arlasExploreApi: ArlasExploreApi

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:182

arlasIamApi

• arlasIamApi: ArlasIamApi

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:184

arlasIsUp

• arlasIsUp: Subject<boolean>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:181

collectionId

• collectionId: string

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:176

collectionsMap

• collectionsMap: Map<string, CollectionReferenceParameters>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:175

configurationUpdaterService

• configurationUpdaterService: ArlasConfigurationUpdaterService

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:183

contributorRegistry

• contributorRegistry: Map<string, Contributor>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:170

emptyMode

• emptyMode: boolean = false

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:172

errorStartUpServiceBus

• errorStartUpServiceBus: Subject<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:180

filtersShortcuts

• filtersShortcuts: FilterShortcutConfiguration[]

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:174

selectorById

• selectorById: string

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:177

shouldRunApp

• shouldRunApp: boolean = true

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:171

temporalContributor

• temporalContributor: string[]

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:178

Methods

applyAppSettings

▸ applyAppSettings(): Promise<ArlasSettings>

  • Fetches and parses the settings.yaml.
  • Validates it against the correponding schema

Returns

Promise<ArlasSettings>

ARLAS settings object Promise

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:376

applyFGA

▸ applyFGA(data): Promise<any>

Retrieves fields that are available for exploration and updates the configuration to keep only corresponding widgets and components

Parameters

Name Type Description
data any configuration object

Returns

Promise<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:341

authenticate

▸ authenticate(settings): Promise<ArlasSettings>

if authentication is configured, trigger authentication service that redirects to login page if it's the first time and fetches the appropriate token

Parameters

Name Type Description
settings ArlasSettings ArlasSettings object

Returns

Promise<ArlasSettings>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:409

buildContributor

▸ buildContributor(data): Promise<any>

Parameters

Name Type
data any

Returns

Promise<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:691

changeOrgHeader

▸ changeOrgHeader(org, accessToken): void

Parameters

Name Type
org string
accessToken string

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:773

enrichHeaders

▸ enrichHeaders(settings): Promise<ArlasSettings>

Enriches headers of calls sent to ARLAS-server & ARLAS-persistence

Parameters

Name Type
settings ArlasSettings

Returns

Promise<ArlasSettings>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:448

errorStartUp

▸ errorStartUp(): void

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:209

getAppConfigurationObject

▸ getAppConfigurationObject(settings): Promise<any>

  • Fetches the configuration file from ARLAS-persistence if it's configurated, otherwise fetches the config.json in "src" folder.
  • Validates the configuration against the corresponding schema

Parameters

Name Type Description
settings ArlasSettings Arlas Settings object

Returns

Promise<any>

ARLAS Configuration object Promise

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:549

getCollections

▸ getCollections(data): Promise<any>

Parameters

Name Type
data any

Returns

Promise<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:641

getFGAService

▸ getFGAService(): ArlasConfigurationUpdaterService

Returns

ArlasConfigurationUpdaterService

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:205

listAvailableFields

▸ listAvailableFields(collectionNames): Promise<Set<string>>

Lists the fields of collectionName that are available for exploration with arlasExploreApi

Parameters

Name Type
collectionNames Set<string>

Returns

Promise<Set<string>>

available fields

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:667

load

▸ load(): Promise<any>

Returns

Promise<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:786

loadExtraConfig

▸ loadExtraConfig(extraConfig, data): Promise<any>

Loads extra configuration declared in the main configuration file.

Parameters

Name Type Description
extraConfig ExtraConfig This object specifies the path to the extra configuration file, the attribute to change in the main configuration file, and the attribute to take from the extra configuration file.
data Object Content of the extra configuration file

Returns

Promise<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:755

setCollaborativeService

▸ setCollaborativeService(data): Promise<any>

Parameters

Name Type
data any

Returns

Promise<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:610

setConfigService

▸ setConfigService(data): any

  • Sets the configuration object in ArlasConfigService.
  • Sets the ArlasConfigService instance in ArlasCollaborativeSearchService

Parameters

Name Type Description
data any configation object

Returns

any

the same configuration object

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:297

testArlasUp

▸ testArlasUp(configData): Promise<any>

Parameters

Name Type
configData any

Returns

Promise<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:623

translationLoaded

▸ translationLoaded(data): Promise<any>

Parameters

Name Type
data any

Returns

Promise<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:269

updateConfiguration

▸ updateConfiguration(data, availableFields): any

Updates configuration by keeping only components/widgets that are availbale for exploration

Parameters

Name Type Description
data any configuration object
availableFields Set<string> list of fields that are available for exploration

Returns

any

the updated configuration object

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:323

validateConfiguration

▸ validateConfiguration(data): Promise<any>

Parameters

Name Type
data any

Returns

Promise<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:234

validateSettings

▸ validateSettings(settings): Promise<any>

Parameters

Name Type
settings any

Returns

Promise<any>

Defined in

projects/arlas-toolkit/src/lib/services/startup/startup.service.ts:214