_ |
Default value : str => str
|
absoluteDateServiceDowngradedInjectable |
Default value : downgradeInjectable(AbsoluteDateService)
|
alertsServiceDowngradedInjectable |
Default value : downgradeInjectable(AlertService)
|
apiServiceDowngradedInjectable |
Default value : downgradeInjectable(ApiService)
|
appStateServiceDowngradedInjectable |
Default value : downgradeInjectable(AppStateService)
|
assetLinkPipeDowngradedInjectable |
Default value : downgradeInjectable(AssetLinkPipe)
|
authBridgeServiceDowngradedInjectable |
Default value : downgradeInjectable(AuthBridgeService)
|
bridgeServiceDowngradedInjectable |
Default value : downgradeInjectable(BridgeService)
|
cachedLocaleDictionaryServiceDowngradedInjectable |
Default value : downgradeInjectable(
CachedLocaleDictionaryService
)
|
datapointSelectorServiceDowngradedInjectable |
Default value : downgradeInjectable(DatapointSelectorService)
|
dateFormatServiceInjectable |
Default value : downgradeInjectable(DateFormatService)
|
deviceGridServiceDowngradedInjectable |
Default value : downgradeInjectable(DeviceGridService)
|
deviceTypeDetailEditedServiceDowngradedInjectable |
Default value : downgradeInjectable(
DeviceTypeDetailEditedService
)
|
docsServiceDowngradedInjectable |
Default value : downgradeInjectable(DocsService)
|
featureCacheServiceDowngradedInjectable |
Default value : downgradeInjectable(FeatureCacheService)
|
filesServiceDowngradedInjectable |
Default value : downgradeInjectable(FilesService)
|
gainsightServiceDowngradedInjectable |
Default value : downgradeInjectable(GainsightService)
|
globalConfigServiceDowngradedInjectable |
Default value : downgradeInjectable(GlobalConfigService)
|
headerServiceDowngradedInjectable |
Default value : downgradeInjectable(HeaderService)
|
modalServiceDowngradedInjectable |
Default value : downgradeInjectable(ModalService)
|
passwordServiceDowngradedInjectable |
Default value : downgradeInjectable(PasswordService)
|
propertyValueTransformServiceDowngradedInjectable |
Default value : downgradeInjectable(
PropertyValueTransformService
)
|
serverMessagesServiceDowngradedInjectable |
Default value : downgradeInjectable(ServerMessagesService)
|
serviceRegistryInjectable |
Default value : downgradeInjectable(ServiceRegistry)
|
translateServiceDowngradedInjectable |
Default value : downgradeInjectable(TranslateService)
|
userMenuServiceDowngradedInjectable |
Default value : downgradeInjectable(UserMenuService)
|
absoluteDateServiceProvider |
Type : object
|
Default value : {
provide: AbsoluteDateService,
useFactory: absoluteDateServiceFactory,
deps: [DatePipe]
}
|
ACTIONS_OPERATIONS |
Default value : {
FILTER: 'filter',
OPEN_OPERATION_DETAILS: 'openOperationDetails',
RETRY: 'retry'
} as const
|
ACTIONS_OPERATIONS__SINGLE |
Default value : {
SCHEDULE_AS_BULK_OPERATION: 'scheduleAsBulkOperation'
} as const
|
BULK_OPERATION_DIALOG_STEPS |
Default value : {
SELECT_OPERATION_TYPE: 'selectOperationType'
} as const
|
BULK_OPERATION_EVENT |
Default value : `${DEVICE_CONTROL_EVENT_PREFIX}:bulk`
|
COMPONENTS |
Default value : {
OPERATION_DETAILS: 'operation-details',
SINGLE_OPERATION_ITEM: 'single-operation-item'
} as const
|
DEVICE_CONTROL_EVENT_PREFIX |
Type : string
|
Default value : 'deviceControl'
|
DEVICE_CONTROL_EVENT_SINGLE_PREFIX |
Default value : `${DEVICE_CONTROL_EVENT_PREFIX}:single`
|
SINGLE_OPERATION_EVENT_DEVICE_TAB |
Default value : `${DEVICE_CONTROL_EVENT_SINGLE_PREFIX}:deviceTab`
|
SINGLE_OPERATION_EVENT_OVERVIEW |
Default value : `${DEVICE_CONTROL_EVENT_SINGLE_PREFIX}:overview`
|
ACTIONS_STEPPER |
Type : object
|
Default value : {
CLICK_STEPPER_CANCEL_BTN: 'clickStepperCancelBtn',
CLICK_STEPPER_NEXT_BTN: 'clickStepperNextBtn',
CLICK_STEPPER_BACK_BTN: 'clickStepperBackBtn',
CLICK_STEPPER_CUSTOM_BTN: 'clickStepperCustomBtn'
}
|
AddButtonTypes |
Default value : {
none: 'none',
addRemove: 'add-remove',
select: 'select'
} as const
|
ADVANCED_TAB_FEATURE_KEY |
Type : string
|
Default value : 'ui.dashboard-details-advanced-tab'
|
advancedTabLabel |
Default value : gettext('Advanced branding')
|
AGGREGATION_ICONS |
Type : Record<aggregationType | "undefined", string>
|
Default value : {
undefined: 'line-chart',
MINUTELY: 'hourglass',
HOURLY: 'clock-o',
DAILY: 'calendar-o'
}
|
AGGREGATION_LIMITS |
Type : object
|
Default value : {
MINUTELY_LIMIT: TimeSpanInMs.MINUTE * 10,
HOURLY_LIMIT: TimeSpanInMs.DAY * 1,
DAILY_LIMIT: TimeSpanInMs.DAY * 4
}
|
AGGREGATION_VALUES |
Default value : {
none: 'NONE',
minutely: aggregationType.MINUTELY,
hourly: aggregationType.HOURLY,
daily: aggregationType.DAILY
} as const
|
AGGREGATION_VALUES_ARR |
Default value : [
AGGREGATION_VALUES.none,
AGGREGATION_VALUES.minutely,
AGGREGATION_VALUES.hourly,
AGGREGATION_VALUES.daily
] as const
|
AGGREGATIONS |
Type : Aggregation[]
|
Default value : [
{ id: null, title: gettext('None') },
{ id: aggregationType.MINUTELY, title: gettext('Minutely') },
{ id: aggregationType.HOURLY, title: gettext('Hourly') },
{ id: aggregationType.DAILY, title: gettext('Daily') }
]
|
ALARM_SEVERITY_ICON |
Default value : {
CIRCLE: 'circle',
HIGH_PRIORITY: 'high-priority',
WARNING: 'warning',
EXCLAMATION_CIRCLE: 'exclamation-circle'
} as const
|
ALARM_SEVERITY_ICON_MAP |
Type : Record<SeverityType, AlarmSeverityIcon>
|
Default value : {
[Severity.CRITICAL]: ALARM_SEVERITY_ICON.EXCLAMATION_CIRCLE,
[Severity.MAJOR]: ALARM_SEVERITY_ICON.WARNING,
[Severity.MINOR]: ALARM_SEVERITY_ICON.HIGH_PRIORITY,
[Severity.WARNING]: ALARM_SEVERITY_ICON.CIRCLE
} as const
|
A lookup table to map alarm severity types to corresponding icons. |
ALARM_STATUS_ICON |
Default value : {
ALERT_IDLE: 'c8y-alert-idle',
BELL_SLASH: 'bell-slash',
BELL: 'bell'
} as const
|
AlarmIconMap |
Type : Record<AlarmStatusType, AlarmStatusIcon>
|
Default value : {
[AlarmStatus.CLEARED]: ALARM_STATUS_ICON.ALERT_IDLE,
[AlarmStatus.ACKNOWLEDGED]: ALARM_STATUS_ICON.BELL_SLASH,
[AlarmStatus.ACTIVE]: ALARM_STATUS_ICON.BELL
} as const
|
A lookup table to map alarm statuses to corresponding icons. |
ALARMS_MODULE_CONFIG |
Default value : new InjectionToken('AlarmsModuleConfig')
|
ALARMS_PATH |
Type : string
|
Default value : 'alarms'
|
DEFAULT_ALARM_COUNTS |
Type : AlarmCount
|
Default value : { CRITICAL: 0, MAJOR: 0, MINOR: 0, WARNING: 0 }
|
DEFAULT_SEVERITY_VALUES |
Type : SeverityFilter
|
Default value : {
[Severity.CRITICAL]: true,
[Severity.MAJOR]: true,
[Severity.MINOR]: true,
[Severity.WARNING]: true
}
|
DEFAULT_STATUS_VALUES |
Type : AlarmStatusSettings
|
Default value : {
[AlarmStatus.ACTIVE]: true,
[AlarmStatus.ACKNOWLEDGED]: true,
[AlarmStatus.CLEARED]: true
}
|
HELP_ICON |
Type : string
|
Default value : 'help'
|
INTERVALS_EXTENDED |
Type : AlarmFilterInterval[]
|
Default value : [
{
id: 'none',
title: gettext('No date filter')
},
...INTERVALS
]
|
THROTTLE_REALTIME_REFRESH |
Type : number
|
Default value : 1_000
|
ALARM_ORDER_VALUES |
Default value : {
BY_ACTIVE: 'BY_ACTIVE',
BY_DATE_ASCENDING: 'BY_DATE_ASCENDING',
BY_DATE_DESCENDING: 'BY_DATE_DESCENDING',
BY_SEVERITY: 'BY_SEVERITY'
} as const
|
ASSET_ALARMS_WIDGET_ID |
Type : string
|
Default value : 'Asset Alarms'
|
GLOBAL_INTERVAL_OPTION |
Type : AlarmListRefreshOption
|
Default value : 'global-interval'
|
RECENT_ALARMS_WIDGET_ID |
Type : string
|
Default value : 'Recent Alarms'
|
ALARM_SEVERITY |
Type : object
|
Default value : {
WARNING: gettext('WARNING'),
MINOR: gettext('MINOR'),
MAJOR: gettext('MAJOR'),
CRITICAL: gettext('CRITICAL')
}
|
ALARM_STATUS |
Type : object
|
Default value : {
ACTIVE: gettext('ACTIVE'),
ACKNOWLEDGED: gettext('ACKNOWLEDGED'),
CLEARED: gettext('CLEARED')
}
|
ALARM_TEXTS |
Type : TimelineTypeTexts
|
Default value : {
listTitle: gettext('Alarms'),
emptyStateIcon: 'c8y-alarm',
emptyStateTitle: gettext('No alarms to display.'),
emptyStateSubtitle: gettext('Add your first alarm.'),
addButtonLabel: gettext('Add alarm'),
addCustomItemButtonLabel: gettext('Add custom alarm'),
selectorTitle: gettext('Alarms selector'),
availableItemsTitle: gettext('Available alarms'),
assetWithNoItemsEmptyStateSubtitle: gettext('Select an asset with alarms from the list.'),
largeNumberOfItemsInfo: gettext(
'Due to the large number, only a subset of alarms are displayed. Use search to narrow down the number of results.'
),
selectedItemsTitle: gettext('Selected alarms'),
noSelectedItemsTitle: gettext('No alarms selected.'),
recentItemsWarningTitle: gettext('The list below may not be complete.'),
recentItemsWarningText: gettext(
'Recent alarms are displayed below. Past alarms might not be shown.'
),
addCustomText: gettext('Optionally you can add a custom alarm.')
}
|
EVENT_TEXTS |
Type : TimelineTypeTexts
|
Default value : {
listTitle: gettext('Events'),
emptyStateIcon: 'online1',
emptyStateTitle: gettext('No events to display.'),
emptyStateSubtitle: gettext('Add your first event.'),
addButtonLabel: gettext('Add event'),
addCustomItemButtonLabel: gettext('Add custom event'),
selectorTitle: gettext('Events selector'),
availableItemsTitle: gettext('Available events'),
assetWithNoItemsEmptyStateSubtitle: gettext('Select an asset with events from the list.'),
largeNumberOfItemsInfo: gettext(
'Due to the large number, only a subset of events are displayed. Use search to narrow down the number of results.'
),
selectedItemsTitle: gettext('Selected events'),
noSelectedItemsTitle: gettext('No events selected.'),
recentItemsWarningTitle: gettext('The list below may not be complete.'),
recentItemsWarningText: gettext(
'Recent events are displayed below. Past events might not be shown.'
),
addCustomText: gettext('Optionally you can add a custom event.')
}
|
alarmListWidgetProviders |
Type : []
|
Default value : [hookWidget(alarmListWidgetDefinition)]
|
algorithmTypeConfig |
Type : object
|
Default value : {
[AlgorithmType.PCKS]: {
name: 'PCKS',
value: 'PCKS',
label: gettext('X.509 certificate (PEM format)')
},
[AlgorithmType.RSA]: {
name: 'RSA',
value: 'RSA',
label: gettext('RSA public key (X.509 Subject Public Key Info)')
}
}
|
certificateTypeConfig |
Type : object
|
Default value : {
[CertificateType.CUSTOM]: {
name: 'CUSTOM',
label: gettext('Custom'),
value: 'CUSTOM',
signatureVerificationConfigFragment: 'manual',
ordinal: 0
},
[CertificateType.AZURE]: {
name: 'AZURE',
label: 'Azure',
value: 'AZURE',
signatureVerificationConfigFragment: 'aad',
ordinal: 1
},
[CertificateType.ADFS]: {
name: 'ADFS',
label: gettext('ADFS manifest'),
value: 'ADFS',
signatureVerificationConfigFragment: 'adfsManifest',
ordinal: 2
},
[CertificateType.JWKS]: {
name: 'JWKS',
label: 'JWKS',
value: 'JWKS',
signatureVerificationConfigFragment: 'jwks',
ordinal: 3
}
}
|
ALL_GLOBAL_ROLES_SELECTED |
Default value : 'all' as const
|
CONTEXT_DASHBOARD_CONFIG |
Default value : new InjectionToken<any>('ContextDashboardConfig')
|
DASHBOARD_DETAILS_OUTLET |
Default value : 'dashboard-details' as const
|
DASHBOARD_DETAILS_TABS_OUTLET_NAME |
Default value : 'dashboardTabs' as const
|
REPORT_DEFAULT_NAVIGATION_NODE_PRIORITY |
Type : number
|
Default value : 30
|
STYLING_CLASS_PREFIXES |
Default value : [
'dashboard-theme-',
'panel-title-',
'panel-content-'
] as const
|
allBrandingCSSVars |
Default value : [
...numberBrandingVars,
...stringBrandingVars,
...colorBrandingVars
] as const
|
brandingFormGroupTopLevelEntries |
Default value : [
'cookieBanner',
'genericApplicationOptions',
'darkThemeAvailable',
'messageBanner'
] as const satisfies ReadonlyArray<BrandingFormKeys>
|
brandingFormGroupTopLevelEntriesToUnpack |
Default value : [
'genericApplicationOptions'
] as const satisfies ReadonlyArray<(typeof brandingFormGroupTopLevelEntries)[number]>
|
numberBrandingVars |
Default value : ['brand-logo-img-height', 'btn-border-radius-base'] as const
|
stringBrandingVars |
Default value : ['brand-logo-img', 'navigator-platform-logo'] as const
|
stringOrNumberBrandingVars |
Default value : ['navigator-platform-logo-height'] as const
|
allIconCategory |
Default value : gettext('All`icons-category`')
|
angularLocalesLanguageMap |
Default value : {
en: 'en-GB',
'en-EN': 'en-GB',
'en-US': 'en',
'ja-JP': 'ja',
'zh-CN': 'zh',
'zh-TW': 'zh',
'pt-BR': 'pt'
} as const
|
The |
APP_STATE |
Type : object
|
Default value : {
SUBSCRIBED: {
label: gettext('Subscribed`application`'),
class: 'label-primary',
tooltip: gettext('Provided by parent tenant.')
},
CUSTOM: {
label: gettext('Custom`application`'),
class: 'label-info',
tooltip: gettext('Manually uploaded to the platform.')
},
EXTERNAL: {
label: gettext('External`application`'),
class: 'label-warning',
tooltip: gettext('Application hosted outside of the platform.')
},
UNPACKED: {
label: gettext('Unpacked`application`'),
class: 'label-success',
tooltip: gettext('Deployed from a package available under "Packages".')
},
PACKAGE_BLUEPRINT: {
label: gettext('Blueprint'),
class: 'label-success',
tooltip: gettext('Contains an application and may include plugins.')
},
PACKAGE_PLUGIN: {
label: gettext('Plugins'),
class: 'label-info',
tooltip: gettext('Contains only plugins.')
},
PACKAGE_UNKNOWN: {
label: gettext('Unknown`package-type`'),
class: 'label-info',
tooltip: gettext('Package contents could not be determined.')
}
}
|
ERROR_MESSAGES |
Type : object
|
Default value : {
[ERROR_TYPE.ALREADY_EXIST]: gettext(
'Could not deploy the application, as an application with the same name`KEEP_ORIGINAL`, context-path`KEEP_ORIGINAL` or key`KEEP_ORIGINAL` exists already.'
),
[ERROR_TYPE.TYPE_VALIDATION]: gettext(
'Wrong file format. Expected a *.zip file with a valid manifest.'
),
[ERROR_TYPE.ALREADY_SUBSCRIBED]: gettext(
'Could not subscribe to the microservice because another application with the same context path is already subscribed.'
),
[ERROR_TYPE.NO_MANIFEST_FILE]: gettext('Could not find a manifest.'),
[ERROR_TYPE.INVALID_PACKAGE]: gettext('You have not uploaded a valid package.'),
[ERROR_TYPE.INVALID_APPLICATION]: gettext('You have not uploaded a valid application.'),
[ERROR_TYPE.INTERNAL_ERROR]: gettext('An internal error occurred, try to upload again.'),
[ERROR_TYPE.MICROSERVICE_NAME_TOO_LONG]: gettext(
'Microservice name "{{ name }}" must not be longer than {{ maxChars }} characters.'
),
[ERROR_TYPE.APPLICATION_CREATION_FAILED]: gettext('Application creation failed.'),
[ERROR_TYPE.KEY_OR_CONTEXT_PATH_MISMATCH]: gettext(
'The "contextPath`KEEP_ORIGINAL`" or "key`KEEP_ORIGINAL`" of the uploaded archive do not match with the existing application.'
),
[ERROR_TYPE.VERSION_NOT_FOUND]: gettext('The selected version was not found on the server.')
}
|
PACKAGE_TYPE_LABELS |
Type : object
|
Default value : {
[PackageType.COMMUNITY]: {
label: gettext('COMMUNITY`Package created by the developer community.`'),
tooltip: gettext('Package created by the developer community.')
},
[PackageType.OFFICIAL]: {
label: gettext('OFFICIAL`Package maintained by Cumulocity.`'),
tooltip: gettext('Package maintained by Cumulocity.')
},
[PackageType.UNKNOWN]: {
label: gettext('CUSTOM`Package maintained by an unknown source.`'),
tooltip: gettext('Package maintainer unknown.')
},
[PackageType.ARCHIVED]: {
label: gettext('ARCHIVED`Package out of maintenance.`'),
tooltip: gettext('The package was marked by the author as archived.')
}
}
|
applicationDetailsRoutes |
Type : Route[]
|
Default value : [
{
path: 'properties',
component: ApplicationPropertiesComponent,
icon: 'list',
label: gettext('Properties'),
context: ViewContext.Application,
priority: 5,
canActivate: [ApplicationPropertiesGuard]
},
{
path: 'application-versions',
component: PackageVersionsComponent,
icon: 'c8y-modules',
label: gettext('Versions'),
context: ViewContext.Application,
priority: 1,
canActivate: [PackageVersionsGuard]
},
{
path: 'properties',
component: ApplicationPropertiesComponent,
icon: 'list',
label: gettext('Properties'),
context: ViewContext.Feature,
priority: 5,
canActivate: [ApplicationPropertiesGuard]
},
{
path: 'package-details',
component: PackageDetailsComponent,
icon: 'big-parcel',
label: gettext('Extension package'),
context: ViewContext.Extension,
priority: 10,
canActivate: [PackageGuard]
},
{
path: 'package-versions',
component: PackageVersionsComponent,
icon: 'c8y-modules',
label: gettext('Versions'),
context: ViewContext.Extension,
priority: 5,
canActivate: [PackageGuard, PackageVersionsGuard]
},
{
path: 'package-changelog',
component: PackageChangelogTabComponent,
icon: 'list',
label: gettext('Change log'),
context: ViewContext.Extension,
priority: 1,
canActivate: [PackageGuard, PackageChangelogGuard]
},
{
path: 'properties',
component: ApplicationPropertiesComponent,
icon: 'list',
label: gettext('Properties'),
context: ViewContext.Microservice,
priority: 5,
canActivate: [ApplicationPropertiesGuard]
}
]
|
ecosystemMainRoutes |
Type : Route[]
|
Default value : [
{
path: 'ecosystem/application',
redirectTo: 'ecosystem/application/applications',
pathMatch: 'full'
},
{
// keeps legacy links functional
path: 'ecosystem/applications',
redirectTo: 'ecosystem/application/applications',
pathMatch: 'full'
},
{
path: 'ecosystem/application/applications',
component: ApplicationListComponent
},
{
path: 'ecosystem/extension/extensions',
component: PackagesListComponent
},
{
path: 'ecosystem/application/features',
component: FeatureListComponent
},
{
path: 'ecosystem/microservice/microservices',
component: MicroserviceListComponent
}
]
|
APPLICATIONS_BASE_PATH |
Type : string
|
Default value : '/ecosystem/application/applications'
|
MICROSERVICES_BASE_PATH |
Type : string
|
Default value : '/ecosystem/microservice/microservices'
|
APPLICATIONS_WIDGET_ID |
Default value : defaultWidgetIds.APPLICATIONS
|
DEFAULT_DISPLAY_OPTION_VALUE |
Default value : QuickLinkDisplayOption.GRID
|
DEFAULT_QUICK_LINK_ICON |
Type : string
|
Default value : 'link'
|
HELP_AND_SERVICE_WIDGET_ID |
Default value : defaultWidgetIds.HELP_AND_SERVICE
|
QUICK_LINKS_DEVICE_MANAGEMENT_ID |
Default value : defaultWidgetIds.DEVICE_MANAGEMENT_WELCOME
|
QuickLinkDisplayOption |
Default value : {
GRID: 'Grid',
LIST: 'List'
} as const
|
URL_VALIDATOR_PATTERN |
Default value : ValidationPattern.rules.quickLinkUrl.pattern
|
applicationsWidgetProviders |
Type : []
|
Default value : [hookWidget(applicationsWidgetDefinition)]
|
appLogsAutoRefreshComponentDowngradedComponent |
Default value : downgradeComponent({
component: AppLogsAutoRefreshComponent
})
|
bootstrapComponentDowngradedComponent |
Default value : downgradeComponent({
component: BootstrapComponent
})
|
dataGridComponentDowngradedComponent |
Default value : downgradeComponent({
component: DataGridComponent
})
|
datapointSelectionListComponentDowngradedComponent |
Default value : downgradeComponent({
component: DatapointSelectionListComponent
})
|
emptyStateComponentDowngradedComponent |
Default value : downgradeComponent({
component: EmptyStateComponent
})
|
helpComponentDowngradedComponent |
Default value : downgradeComponent({ component: HelpComponent })
|
highlightComponentDowngradedComponent |
Default value : downgradeComponent({
component: HighlightComponent,
inputs: ['pattern', 'text']
})
|
loadingComponentDowngradedComponent |
Default value : downgradeComponent({
component: LoadingComponent
})
|
paginationComponentDowngradedComponent |
Default value : downgradeComponent({
component: PaginationComponent
})
|
passwordInputComponentDowngradedComponent |
Default value : downgradeComponent({
component: PasswordInputComponent
})
|
platformConfigurationFormDowngradedComponent |
Default value : downgradeComponent({
component: PlatformConfigurationFormComponent
})
|
rangeDisplayComponentDowngradedComponent |
Default value : downgradeComponent({
component: RangeDisplayComponent
})
|
rolesAssetTreeComponentDowngradedComponent |
Default value : downgradeComponent({
component: RolesAssetTreeComponent
})
|
userTotpComponentDowngradedComponent |
Default value : downgradeComponent({
component: UserTotpRevokeComponent
})
|
widgetPreviewWrapperDowngradedComponent |
Default value : downgradeComponent({
component: WidgetPreviewWrapperComponent
})
|
ARRAY_VALIDATION_PREFIX |
Type : string
|
Default value : 'INNER_ARRAY_ERROR_'
|
arrayTypeConfig |
Default value : (): EnvironmentProviders =>
importProvidersFrom(
FormlyModule.forChild({ types: [{ name: 'array', component: ArrayTypeComponent }] })
)
|
arrowIconCategory |
Default value : {
label: gettext('Arrow`icons-category`'),
icons: arrowIcons
} as const
|
ASSET_NAVIGATOR_CONFIG |
Default value : new InjectionToken<AssetNavigatorConfig>('AssetNodeConfig')
|
assetNotesWidgetProviders |
Type : []
|
Default value : [hookWidget(assetNotesWidgetDefinition)]
|
authBridgeServiceProvider |
Type : object
|
Default value : {
provide: AuthBridgeService,
useFactory: authBridgeServiceFactory,
deps: ['$injector', BasicAuth, FetchClient, AppStateService, TenantUiService]
}
|
AXIS_TYPES |
Default value : [
{ val: undefined, text: gettext('Auto') },
{ val: 'left', text: gettext('Left') },
{ val: 'right', text: gettext('Right') }
] as const
|
CHART_RENDER_TYPES |
Default value : [
{ val: 'min', text: gettext('Minimum') },
{ val: 'max', text: gettext('Maximum') },
{ val: 'area', text: gettext('Minimum and maximum') }
] as const
|
basePath |
Type : string
|
Default value : 'monitoring/messaging-service'
|
MESSAGING_MANAGEMENT_FEATURE_KEY |
Type : string
|
Default value : 'messaging-management.api'
|
MESSAGING_MANAGEMENT_MICROSERVICE_NAME |
Type : string
|
Default value : 'messaging-management'
|
baseUrl |
Type : string
|
Default value : 'devicecontrol/bulk/creation/'
|
HOOK_LIST_BULK_TYPE |
Consider using the `hookListBulkType` function instead. |
Default value : new InjectionToken<OperationType | OperationType[]>(
'HOOK_LIST_BULK_TYPE'
)
|
BRANDING_EDIT_CHILD_ROUTES |
Type : Route[]
|
Default value : [
{
path: '',
pathMatch: 'full',
redirectTo: 'generic'
},
{
path: 'generic',
loadComponent: () =>
import('@c8y/ngx-components/branding/shared/lazy').then(m => m.BrandingFormComponent),
data: {
tabName: genericTabName
}
},
{
path: 'light',
loadComponent: () =>
import('@c8y/ngx-components/branding/shared/lazy').then(m => m.BrandingThemeFormComponent),
data: {
tabName: lightThemeTabName
}
}
]
|
bridgeServiceProvider |
Type : object
|
Default value : {
provide: BridgeService,
useFactory: bridgeServiceFactory,
deps: [
'$injector',
AppStateService,
Router,
NgZone,
RouterService,
ActionService,
PluginsResolveService
]
}
|
BULK_OPERATION_STATUS_LABELS |
Type : object
|
Default value : {
SCHEDULED: gettext('Scheduled'),
EXECUTING: gettext('Executing'),
CANCELED: gettext('Canceled'),
FAILED: gettext('Completed with failures'),
SUCCESSFUL: gettext('Completed successfully'),
DELETED: gettext('Deleted')
}
|
BULK_OPERATION_STATUS_OPTIONS |
Type : OperationStatusOptionsMap
|
Default value : {
SCHEDULED: {
label: BULK_OPERATION_STATUS_LABELS.SCHEDULED,
generalStatuses: [OperationBulkGeneralStatus.SCHEDULED],
icon: 'calendar',
styleClass: 'text-info'
},
EXECUTING: {
label: BULK_OPERATION_STATUS_LABELS.EXECUTING,
generalStatuses: [
OperationBulkGeneralStatus.EXECUTING,
OperationBulkGeneralStatus.EXECUTING_WITH_ERROR
],
icon: 'refresh',
styleClass: 'text-primary'
},
DELETED: {
label: BULK_OPERATION_STATUS_LABELS.DELETED,
generalStatuses: [OperationBulkGeneralStatus.DELETED],
icon: 'delete-document',
styleClass: 'text-muted'
},
CANCELED: {
label: BULK_OPERATION_STATUS_LABELS.CANCELED,
generalStatuses: [OperationBulkGeneralStatus.CANCELED],
icon: 'ban',
styleClass: 'text-primary'
},
FAILED: {
label: BULK_OPERATION_STATUS_LABELS.FAILED,
generalStatuses: [OperationBulkGeneralStatus.FAILED],
icon: 'exclamation-circle',
styleClass: 'text-danger'
},
SUCCESSFUL: {
label: BULK_OPERATION_STATUS_LABELS.SUCCESSFUL,
generalStatuses: [OperationBulkGeneralStatus.SUCCESSFUL],
icon: 'check-circle',
styleClass: 'text-success'
}
}
|
BULK_OPERATION_WRAPPER_MODAL_BODY_COMPONENT |
Default value : new InjectionToken<BulkOperationDetailsModalBodyConfiguration>(
'BulkOperationWrapperModalBodyComponent'
)
|
bulkOperationAuditLogTextPlaceholders |
Type : object
|
Default value : {
updatesList: {
capture: '$1',
translate: {
"status='(.+?)'": {
gettext: gettext('status: "{{ status | translate }}"'),
placeholders: {
status: '$1'
}
},
"generalStatus='(.+?)'": {
gettext: gettext('general status: "{{ generalStatus | translate }}"'),
placeholders: {
generalStatus: '$1'
}
},
"progress='(.+?)'": {
gettext: gettext('progress: "{{ progress }}"'),
placeholders: {
progress: '$1'
}
},
'note=(.+?)': {
gettext: gettext('note: "{{ note }}"'),
placeholders: {
note: '$1'
}
}
}
}
}
|
bulkOperationCreateSingleRoutes |
Type : Route[]
|
Default value : [
{
path: 'devicecontrol/single/create-bulk/:operationId',
component: BulkOperationFromSingleComponent
}
]
|
bulkOperationListRoutes |
Type : Route[]
|
Default value : [
{
path: 'devicecontrol/bulk',
component: BulkOperationsListComponent
}
]
|
bulkOperatioStepperRoutes |
Type : Route[]
|
Default value : [
{
path: 'devicecontrol/bulk/creation/:type',
component: BulkOperationsStepperContainerComponent
}
]
|
cache |
Default value : new Map()
|
CHILD_PAGE_SIZE |
Type : number
|
Default value : 5
|
ROOT_PAGE_SIZE |
Type : number
|
Default value : 25
|
cityIconCategory |
Default value : {
label: gettext('City`icons-category`'),
icons: cityIcons
} as const
|
CLEAN_KEYS |
Type : []
|
Default value : ['creationTime', 'deviceExternalIDs', 'id', 'self']
|
CLEAN_KEYS_UPDATE |
Type : []
|
Default value : ['deviceId', 'deviceName', 'bulkOperationId']
|
OPERATION_STATUS_LABELS |
Type : object
|
Default value : {
PENDING: gettext('Pending'),
EXECUTING: gettext('Executing'),
FAILED: gettext('Failed'),
SUCCESSFUL: gettext('Successful')
}
|
OPERATION_STATUS_OPTIONS_MAP |
Type : OperationStatusOptionsMapShared
|
Default value : {
PENDING: {
label: OPERATION_STATUS_LABELS.PENDING,
status: OperationStatus.PENDING,
icon: 'clock-o',
styleClass: ''
} as unknown as OperationStatusOption,
EXECUTING: {
label: OPERATION_STATUS_LABELS.EXECUTING,
status: OperationStatus.EXECUTING,
icon: 'refresh',
styleClass: 'text-info'
} as unknown as OperationStatusOption,
SUCCESSFUL: {
label: OPERATION_STATUS_LABELS.SUCCESSFUL,
status: OperationStatus.SUCCESSFUL,
icon: 'check-circle',
styleClass: 'text-success'
} as unknown as OperationStatusOption,
FAILED: {
label: OPERATION_STATUS_LABELS.FAILED,
status: OperationStatus.FAILED,
icon: 'exclamation-circle',
styleClass: 'text-danger'
} as unknown as OperationStatusOption
}
|
RESERVED_KEYS |
Default value : CLEAN_KEYS.concat(['deviceId', 'deviceName', 'bulkOperationId'])
|
STANDARD_KEYS |
Type : object
|
Default value : {
failureReason: gettext('Failure reason'),
description: gettext('Description'),
status: gettext('Status')
}
|
COCKPIT_CONFIG_PATH |
Type : string
|
Default value : 'cockpit-application-configuration'
|
DEFAULT_CONFIG |
Type : CockpitConfig
|
Default value : {
rootNodes: [],
features: {
alarms: true,
dataExplorer: true,
groups: true,
reports: true,
exports: true,
dataPointLibrary: true,
globalSmartRules: true,
smartRules: true,
subassets: true,
search: true,
dashboardManager: true
},
hideNavigator: false,
homeDashboardName: DEFAULT_HOME_DASHBOARD_NAME,
userSpecificHomeDashboard: false,
icon: {
class: 'c8y-cockpit'
},
htmlWidgetDisableSanitization: false,
htmlWidgetDefaultToAdvancedMode: false
}
|
DEFAULT_HOME_DASHBOARD_NAME |
Type : string
|
Default value : 'home-cockpit1'
|
USER_HOME_DASHBOARD_NAME |
Type : string
|
Default value : 'home-cockpit-user'
|
COCKPIT_HOME_DASHBOARD_CONFIG |
Default value : new InjectionToken('CockpitHomeDashboardConfig')
|
A hook to define the default widgets of the home dashboard in the cockpit app. |
cockpitWelcomeWidgetProviders |
Type : []
|
Default value : [hookWidget(cockpitWelcomeWidgetDefinition)]
|
CONFIG_OPTIONS_DEFAULT |
Type : AssetSelectorOptions
|
Default value : {
label: gettext('Asset selection'),
multi: false,
showFilter: false,
columnHeaders: false,
singleColumn: false,
modelMode: 'simple',
groupsOnly: false,
groupsSelectable: false,
search: false,
showUnassignedDevices: false,
view: 'tree',
showChildDevices: false,
showSelected: true
}
|
connectivityRoutes |
Type : Route[]
|
Default value : [
{
path: 'connectivitySettings',
component: ConditionalTabsOutletComponent
}
]
|
CopyDashboardDisabledReason |
Default value : {
PERMISSIONS: 'PERMISSIONS',
WRONG_REFERENCE: 'WRONG_REFERENCE'
} as const
|
NEW_DASHBOARD_ROUTER_STATE_PROP |
Type : string
|
Default value : 'newDashboard'
|
criticalAlarmsWidgetProviders |
Type : []
|
Default value : [hookWidget(criticalAlarmsWidgetDefinition)]
|
CSVGeneratorAdapter |
Type : FileGenerator
|
Default value : {
getLabel: CSVGenerator.getLabel.bind(CSVGenerator),
getIcon: CSVGenerator.getIcon.bind(CSVGenerator),
getFileExtension: CSVGenerator.getFileExtension.bind(CSVGenerator),
getMimeType: CSVGenerator.getMimeType.bind(CSVGenerator),
generateMerged: CSVGenerator.convertToMergedCSV.bind(CSVGenerator),
getType: CSVGenerator.getType.bind(CSVGenerator),
getTitle: CSVGenerator.getTitle.bind(CSVGenerator),
getZipName: CSVGenerator.getZipName.bind(CSVGenerator),
getAcceptType: CSVGenerator.getAcceptType.bind(CSVGenerator)
}
|
csvHeaders |
Type : string[]
|
Default value : [
'ID',
'TYPE',
'NAME',
'ICCID',
'IDTYPE',
'PATH',
'SHELL',
'AUTH_TYPE'
]
|
ESTCsvHeaders |
Type : string[]
|
Default value : [...csvHeaders, 'ENROLLMENT_OTP']
|
fullCsvHeaders |
Type : string[]
|
Default value : [...csvHeaders, 'CREDENTIALS']
|
registerDeviceBulkSchema |
Type : object
|
Default value : {
$schema: 'https://json-schema.org/draft/2019-09/schema',
type: 'object',
properties: {
csvBulkFile: {
type: 'array',
title: gettext('CSV file upload'),
description: gettext(
'You can use file upload component to let users send files. This input accepts only a single CSV file.'
),
contentMediaType: 'csv'
}
},
required: ['csvBulkFile'],
additionalProperties: false
}
|
simpleCsvHeaders |
Type : string[]
|
Default value : ['ID', 'PATH']
|
CUMULOCITY_JSON |
Type : string
|
Default value : 'cumulocity.json'
|
MICROSERVICE_NAME_MAX_LENGTH |
Type : number
|
Default value : 23
|
CUSTOM |
Type : object
|
Default value : { label: gettext('Custom') }
|
INTERVAL_OPTIONS |
Type : TimeIntervalOption[]
|
Default value : [
LAST_MINUTE,
LAST_HOUR,
LAST_DAY,
LAST_WEEK,
LAST_MONTH,
CUSTOM
]
|
LAST_DAY |
Type : object
|
Default value : {
label: gettext('Last day'),
getStartDate: () => {
const start = new Date();
start.setDate(start.getDate() - 1);
start.setHours(0, 0, 0, 0);
return start;
}
}
|
LAST_HOUR |
Type : object
|
Default value : {
label: gettext('Last hour'),
getStartDate: () => {
const start = new Date();
start.setHours(start.getHours() - 1);
return start;
}
}
|
LAST_MINUTE |
Type : TimeIntervalOption
|
Default value : {
label: gettext('Last minute'),
getStartDate: () => {
const start = new Date();
start.setMinutes(start.getMinutes() - 1);
return start;
}
}
|
LAST_MONTH |
Type : object
|
Default value : {
label: gettext('Last month'),
getStartDate: () => {
const start = new Date();
start.setMonth(start.getMonth() - 1);
start.setHours(0, 0, 0, 0);
return start;
}
}
|
LAST_WEEK |
Type : object
|
Default value : {
label: gettext('Last week'),
getStartDate: () => {
const start = new Date();
start.setDate(start.getDate() - 7);
start.setHours(0, 0, 0, 0);
return start;
}
}
|
darkThemeTabName |
Default value : gettext('Dark theme')
|
DASHBOARD_MANAGER_PATH |
Type : string
|
Default value : 'dashboard-manager'
|
dataBrokerSubscriptionsServiceDowngradedInjectable |
Default value : downgradeInjectable(
DataBrokerSubscriptionsService
)
|
dataIconCategory |
Default value : {
label: gettext('Data`icons-category`'),
icons: dataIcons
} as const
|
DATAPOINT_LIBRARY_CONFIG |
Default value : new InjectionToken<DatapointLibraryOptions>(
'DatapointLibraryOptions'
)
|
pathToDatapointLibrary |
Type : string
|
Default value : 'datapointlibrary'
|
DATAPOINT_LIBRARY_FRAGMENT |
Type : string
|
Default value : 'c8y_Kpi'
|
dataPointsTableWidgetProviders |
Type : []
|
Default value : [hookWidget(dataPointsTableWidgetDefinition)]
|
DataType |
Default value : {
publishers: 'publishers',
subscribers: 'subscribers',
topics: 'topics'
} as const
|
DATE_SELECTION_VALUES |
Default value : {
dashboard_context: 'dashboard_context',
config: 'config',
view_and_config: 'view_and_config'
} as const
|
DATE_SELECTION_VALUES_ARR |
Default value : [
DATE_SELECTION_VALUES.dashboard_context,
DATE_SELECTION_VALUES.config,
DATE_SELECTION_VALUES.view_and_config
] as const
|
DEFAULT_DPT_REFRESH_INTERVAL_VALUE |
Type : number
|
Default value : 30_000
|
INTERVAL_VALUES_ARR |
Default value : [
INTERVAL_VALUES.minutes,
INTERVAL_VALUES.hours,
INTERVAL_VALUES.days,
INTERVAL_VALUES.weeks,
INTERVAL_VALUES.months,
INTERVAL_VALUES.custom
] as const
|
REFRESH_INTERVAL_VALUES_ARR |
Type : []
|
Default value : [5_000, 10_000, 15_000, 30_000, 60_000]
|
RENDER_TYPES_LABELS |
Default value : {
min: gettext('Minimum') as 'Minimum',
max: gettext('Maximum') as 'Maximum',
area: gettext('Area') as 'Area'
} as const
|
dateAndTimeIconCategory |
Default value : {
label: gettext('Date and time`icons-category`'),
icons: dateAndTimeIcons
} as const
|
FILE_GENERATORS |
Default value : new InjectionToken<FileGenerator[]>('FILE_GENERATORS', {
providedIn: 'root',
factory: () => [ExcelGeneratorAdapter, CSVGeneratorAdapter]
})
|
DEFAULT_DUPLICATE_WITHOUT_TYPE |
Default value : () => {
throw new Error('duplicateWithoutTypeFn Not implemented');
}
|
DEFAULT_PREVIEW_CHANGED |
Default value : () => {
throw new Error('previewChanged Not implemented');
}
|
DEFAULT_REVERT_TO_DASHBOARD |
Default value : () => {
throw new Error('revertToDashboard Not implemented');
}
|
DEFAULT_INTERVAL_STATE |
Default value : true
|
DEFAULT_INTERVAL_VALUE |
Type : number
|
Default value : 30_000
|
DEFAULT_INTERVAL_VALUES |
Type : []
|
Default value : [5_000, 10_000, 15_000, 30_000, 60_000]
|
GLOBAL_CONTEXT_AUTO_REFRESH |
Type : string
|
Default value : 'globalContextAutoRefresh'
|
DEFAULT_PAGE_SIZE |
Type : number
|
Default value : 20
|
DEFAULT_VERSIONS_LIMIT |
Type : number
|
Default value : 20
|
defaultAlarmsConfig |
Type : AlarmsModuleConfig
|
Default value : {
hybrid: true
}
|
defaultAssetProperties |
Type : Array<BaseProperty>
|
Default value : [
{
c8y_JsonSchema: { properties: { name: { type: 'string', label: 'Name' } } },
name: 'name',
label: 'Name',
type: 'string',
active: true,
isEditable: true,
isStandardProperty: true
},
{
c8y_JsonSchema: { properties: { id: { type: 'string', label: 'ID' } } },
name: 'id',
label: 'ID',
type: 'string',
active: true,
isEditable: false,
isStandardProperty: true
},
{
c8y_JsonSchema: {
properties: { type: { type: 'string', label: 'Type' } }
},
name: 'type',
label: 'Type',
type: 'string',
active: true,
isEditable: false,
isStandardProperty: true
},
{
c8y_JsonSchema: {
properties: { owner: { type: 'string', label: 'Owner' } }
},
name: 'owner',
label: 'Owner',
type: 'string',
isEditable: false,
isStandardProperty: true
},
{
c8y_JsonSchema: {
properties: { lastUpdated: { type: 'string', label: 'Last updated' } }
},
name: 'lastUpdated',
label: 'Last updated',
type: 'string',
isEditable: false,
isStandardProperty: true
}
]
|
defaultAssetPropertyListConfig |
Type : AssetPropertyListConfig
|
Default value : {
searchable: true,
selectMode: 'none',
expansionMode: 'expandedByDefault',
showHeader: true,
showValue: true,
showKey: true,
emptyStateContent: 'empty',
inputPropertiesHandle: 'merge'
}
|
deviceAssetProperties |
Type : Array<BaseProperty>
|
Default value : [
{
label: 'Active alarms status',
type: 'object',
isEditable: false,
isStandardProperty: true,
name: 'c8y_ActiveAlarmsStatus',
c8y_JsonSchema: {
properties: {
c8y_ActiveAlarmsStatus: {
key: 'c8y_ActiveAlarmsStatus',
type: 'object',
label: 'Active alarms status',
properties: {
critical: {
title: 'Critical',
type: 'number'
},
major: {
title: 'Major',
type: 'number'
},
minor: {
title: 'Minor',
type: 'number'
},
warning: {
title: 'Warning',
type: 'number'
}
}
}
}
}
},
{
label: 'Address',
type: 'object',
isEditable: true,
isStandardProperty: true,
name: 'c8y_Address',
c8y_JsonSchema: {
properties: {
c8y_Address: {
key: 'c8y_Address',
type: 'object',
label: 'Address',
properties: {
street: {
title: 'Street',
type: 'string'
},
city: {
title: 'City',
type: 'string'
},
cityCode: {
title: 'City code',
type: 'string'
},
territory: {
title: 'Territory',
type: 'string'
},
region: {
title: 'Region',
type: 'string'
},
country: {
title: 'Country',
type: 'string'
}
}
}
}
}
},
{
label: 'Agent',
type: 'object',
isEditable: true,
isStandardProperty: true,
name: 'c8y_Agent',
c8y_JsonSchema: {
properties: {
c8y_Agent: {
key: 'c8y_Agent',
type: 'object',
label: 'Agent',
properties: {
name: {
title: 'Name',
type: 'string'
},
version: {
title: 'Version',
type: 'string'
},
url: {
title: 'URL',
type: 'string'
},
maintainer: {
title: 'Maintainer',
type: 'string'
}
}
}
}
}
},
{
label: 'Availability',
type: 'object',
isEditable: false,
isStandardProperty: true,
name: 'c8y_Availability',
c8y_JsonSchema: {
properties: {
c8y_Availability: {
key: 'c8y_Availability',
type: 'object',
label: 'Availability',
properties: {
status: {
title: 'Status',
type: 'string'
},
lastMessage: {
title: 'Last message',
type: 'string',
printFormat: 'datetime'
}
}
}
}
}
},
{
label: 'Connection',
type: 'object',
isEditable: false,
isStandardProperty: true,
name: 'c8y_Connection',
c8y_JsonSchema: {
properties: {
c8y_Connection: {
key: 'c8y_Connection',
type: 'object',
label: 'Connection',
properties: {
status: {
title: 'Status',
type: 'string'
}
}
}
}
}
},
{
label: 'Communication mode',
type: 'object',
isEditable: true,
isStandardProperty: true,
name: 'c8y_CommunicationMode',
c8y_JsonSchema: {
properties: {
c8y_CommunicationMode: {
key: 'c8y_CommunicationMode',
type: 'object',
label: 'Communication mode',
properties: {
mode: {
title: 'Mode',
type: 'string'
}
}
}
}
}
},
{
label: 'Firmware',
type: 'object',
isEditable: false,
isStandardProperty: true,
name: 'c8y_Firmware',
c8y_JsonSchema: {
properties: {
c8y_Firmware: {
key: 'c8y_Firmware',
type: 'object',
label: 'Firmware',
properties: {
moduleVersion: {
title: 'Module version',
type: 'string'
},
name: {
title: 'Name',
type: 'string'
},
version: {
title: 'Version',
type: 'string'
},
url: {
title: 'URL',
type: ['string', 'null']
}
}
}
}
}
},
{
label: 'Hardware',
type: 'object',
isEditable: true,
isStandardProperty: true,
name: 'c8y_Hardware',
c8y_JsonSchema: {
properties: {
c8y_Hardware: {
key: 'c8y_Hardware',
type: 'object',
label: 'Hardware',
properties: {
model: {
title: 'Model',
type: 'string'
},
serialNumber: {
title: 'Serial number',
type: 'string'
},
revision: {
title: 'Revision',
type: 'string'
}
}
}
}
}
},
{
label: 'LPWAN device',
type: 'object',
isEditable: false,
isStandardProperty: true,
name: 'c8y_LpwanDevice',
c8y_JsonSchema: {
properties: {
c8y_LpwanDevice: {
key: 'c8y_LpwanDevice',
type: 'object',
label: 'LPWAN device',
properties: {
provisioned: {
title: 'Provisioned',
type: 'boolean'
}
}
}
}
}
},
{
label: 'Mobile',
type: 'object',
isEditable: true,
isStandardProperty: true,
name: 'c8y_Mobile',
c8y_JsonSchema: {
properties: {
c8y_Mobile: {
key: 'c8y_Mobile',
type: 'object',
label: 'Mobile',
properties: {
cellId: {
title: 'Cell ID',
type: ['string', 'null']
},
connType: {
title: 'Connection type',
type: 'string',
readOnly: true
},
currentOperator: {
title: 'Current operator',
type: 'string',
readOnly: true
},
currentBand: {
title: 'Current band',
type: 'string',
readOnly: true
},
ecn0: {
title: 'ECN0',
type: 'string',
readOnly: true
},
iccid: {
title: 'ICCID',
type: ['string', 'null']
},
imei: {
title: 'IMEI',
type: ['string', 'null']
},
imsi: {
title: 'IMSI',
type: ['string', 'null']
},
lac: {
title: 'LAC',
type: ['string', 'null']
},
mcc: {
title: 'MCC',
type: ['string', 'null']
},
mnc: {
title: 'MNC',
type: ['string', 'null']
},
msisdn: {
title: 'MSISDN',
type: 'string'
},
rcsp: {
title: 'RCSP',
type: 'string',
readOnly: true
},
rscp: {
title: 'RSCP',
type: 'string',
readOnly: true
},
rsrp: {
title: 'RSRP',
type: 'string',
readOnly: true
},
rsrq: {
title: 'RSRQ',
type: 'string',
readOnly: true
},
rssi: {
title: 'RSSI',
type: 'string',
readOnly: true
}
}
}
}
}
},
{
name: 'c8y_Notes',
label: 'Notes',
type: 'string',
isEditable: true,
isStandardProperty: true,
c8y_JsonSchema: {
properties: {
c8y_Notes: {
type: 'string',
label: 'Notes',
'x-schema-form': {
type: 'textarea'
}
}
}
}
},
{
label: 'Position',
type: 'object',
isEditable: true,
isStandardProperty: true,
name: 'c8y_Position',
c8y_JsonSchema: {
properties: {
c8y_Position: {
key: 'c8y_Position',
type: 'object',
label: 'Position',
properties: {
lat: {
title: 'Latitude',
type: 'number'
},
lng: {
title: 'Longitude',
type: 'number'
},
alt: {
title: 'Altitude',
type: 'number'
}
}
}
}
}
},
{
label: 'Required availability',
type: 'object',
isEditable: true,
isStandardProperty: true,
name: 'c8y_RequiredAvailability',
c8y_JsonSchema: {
properties: {
c8y_RequiredAvailability: {
key: 'c8y_RequiredAvailability',
type: 'object',
label: 'Required availability',
properties: {
responseInterval: {
title: 'Response interval',
description:
'Takes a value between -32768 and 32767 minutes (a negative value indicates that the device is under maintenance).',
type: 'integer',
minimum: -32768,
maximum: 32767
}
}
}
}
}
},
{
label: 'Software',
type: 'object',
isEditable: false,
isStandardProperty: true,
name: 'c8y_Software',
c8y_JsonSchema: {
properties: {
c8y_Software: {
key: 'c8y_Software',
type: 'object',
label: 'Software',
properties: {
name: {
title: 'Name',
type: 'string'
},
version: {
title: 'Version',
type: 'string'
},
url: {
title: 'URL',
type: ['string', 'null']
}
}
}
}
}
},
{
label: 'Network',
type: 'object',
isEditable: true,
isStandardProperty: true,
name: 'c8y_Network',
c8y_JsonSchema: {
properties: {
c8y_Network: {
key: 'c8y_Network',
type: 'object',
label: 'Network',
properties: {
c8y_DHCP: {
title: 'DHCP',
type: 'object',
printFormat: 'hidden',
name: 'c8y_DHCP',
properties: {
addressRange: {
title: 'Address range',
type: 'object',
name: 'addressRange',
printFormat: 'hidden',
properties: {
start: {
title: 'Start',
type: 'string'
},
end: {
title: 'End',
type: 'string'
}
}
},
dns1: {
title: 'DNS 1',
type: 'string'
},
dns2: {
title: 'DNS 2',
type: 'string'
},
enabled: {
title: 'Enabled',
type: 'integer'
}
}
},
c8y_LAN: {
title: 'LAN',
type: 'object',
name: 'c8y_LAN',
printFormat: 'hidden',
properties: {
enabled: {
title: 'Enabled',
type: 'integer'
},
ip: {
title: 'IP',
type: 'string'
},
mac: {
title: 'MAC',
type: 'string'
},
name: {
title: 'Name',
type: 'string'
},
netmask: {
title: 'Netmask',
type: 'string'
}
}
},
c8y_WAN: {
title: 'WAN',
type: 'object',
name: 'c8y_WAN',
printFormat: 'hidden',
properties: {
apn: {
title: 'APN',
type: 'string'
},
authType: {
title: 'Auth type',
type: 'string'
},
ip: {
title: 'IP',
type: 'string'
},
password: {
title: 'Password',
type: 'string'
},
simStatus: {
title: 'SIM status',
type: 'string'
},
username: {
title: 'Username',
type: 'string'
}
}
}
}
}
}
}
}
]
|
RESULT_TYPES |
Type : object
|
Default value : {
VALUE: { name: 'VALUE', value: 1, label: gettext('Only value') },
VALUE_UNIT: { name: 'VALUE_UNIT', value: 2, label: gettext('Value and unit') },
VALUE_UNIT_TIME: { name: 'VALUE_UNIT_TIME', value: 3, label: gettext('Value, unit and time') }
}
|
defaultConfig |
Default value : {
allowFullscreen: true
} as const satisfies ContextDashboardConfig
|
defaultFilters |
Type : object
|
Default value : {
query: "(type eq 'c8y_JsonSchema') and (appliesTo.TENANTS eq true)",
pageSize: 1000,
withTotalPages: true
}
|
defaultFitBoundsOptions |
Type : L.FitBoundsOptions
|
Default value : {
padding: [50, 50]
}
|
Default options for fitting map bounds (padding). |
defaultMapConfig |
Type : MapDefaultConfig
|
Default value : {
center: [51.23544, 6.79599], // Düsseldorf
zoomLevel: 2
}
|
Default map configuration (centered on Düsseldorf, zoom level 2). |
MAP_DEFAULT_CONFIG |
Default value : new InjectionToken<Observable<MapDefaultConfig>>(
'MAP_DEFAULT_CONFIG'
)
|
Injection token for providing the default map configuration as an observable. |
MAP_TILE_LAYER |
Default value : new InjectionToken<Observable<MapTileLayer[]>>('MAP_TILE_LAYER')
|
Injection token for providing map tile layers as an observable. |
defaultMapLocation |
Default value : {
lat: defaultMapConfig.center[0],
lng: defaultMapConfig.center[1]
} as const
|
defaultModuleConfig |
Type : SubAssetsConfig
|
Default value : {
showAddGroupBtn: true,
showAssignDeviceBtn: true,
name: gettext('Groups'),
baseQuery: {},
showDetails: true,
showProperties: true,
showGroupsContextHelp: true
}
|
SUB_ASSETS_CONFIG |
Default value : new InjectionToken<SubAssetsConfig>('SubAssetsConfig')
|
defaultObjectFitValue |
Type : string
|
Default value : 'contain'
|
defaultObjectPositionValue |
Type : string
|
Default value : 'center'
|
defaultPackageAvailabilities |
Type : []
|
Default value : [
APP_STATE.SUBSCRIBED.label,
APP_STATE.UNPACKED.label,
APP_STATE.EXTERNAL.label,
APP_STATE.CUSTOM.label
]
|
defaultPackageContents |
Type : []
|
Default value : [
APP_STATE.PACKAGE_BLUEPRINT.label,
APP_STATE.PACKAGE_PLUGIN.label
]
|
defaultPackageTypes |
Type : []
|
Default value : [
PackageType.OFFICIAL,
PackageType.COMMUNITY
]
|
defaultTokenValidationRequest |
Type : SSORequest
|
Default value : {
body: 'token=${accessToken}&client_id=${clientId}&client_secret=',
url: '',
headers: {},
method: 'POST',
operation: 'EXECUTE',
requestParams: {}
}
|
defaultUserIdConfig |
Type : UserIdConfig
|
Default value : {
jwtField: '',
useConstantValue: true
}
|
validationMethodConfig |
Type : object
|
Default value : {
[ValidationMethod.INTROSPECTION]: {
name: 'INTROSPECTION',
value: 'INTROSPECTION',
label: gettext('Introspection`Method of validating access token from external IAM system`'),
defaults: {
method: 'POST',
body: 'token=${accessToken}&client_id=${clientId}&client_secret=',
url: '',
headers: {},
operation: 'EXECUTE',
requestParams: {}
}
},
[ValidationMethod.USERINFO]: {
name: 'USERINFO',
value: 'USERINFO',
label: gettext('User info`Method of validating access token from external IAM system`'),
defaults: {
url: '',
method: 'GET',
body: '',
headers: { Authorization: 'Bearer ${accessToken}' },
operation: 'EXECUTE',
requestParams: {}
}
}
}
|
defaultWebComponentAttributeNameContext |
Type : string
|
Default value : 'c8yContext'
|
defaultWebComponentName |
Type : string
|
Default value : 'DefaultWebComponent'
|
INITIAL_CSS_FORMATTED |
Default value : `
:host > div {
padding: var(--c8y-root-component-padding-default);
}
span.branded {
color: var(--brand-primary, var(--c8y-brand-primary));
}`
|
DEVICE_CONTROL_NAVIGATOR_NODE_CONFIG |
Default value : new InjectionToken<Partial<NavigatorNode>>(
'DEVICE_CONTROL_NAVIGATOR_NODE_CONFIG'
)
|
DEVICE_SHELL_ROUTE |
Type : Route
|
Default value : {
path: 'shell',
context: ViewContext.Device,
component: DeviceShellComponent,
label: gettext('Shell'),
icon: 'terminal',
canActivate: [DeviceShellGuard]
}
|
deviceAvailabilityIconMap |
Type : object
|
Default value : {
sendData: {
[SendStatus.AVAILABLE]: {
icon: 'long-arrow-right',
class: 'statusOk'
},
[SendStatus.UNAVAILABLE]: {
icon: 'long-arrow-right',
class: 'statusNok'
},
[SendStatus.UNKNOWN]: {
icon: 'long-arrow-right',
class: 'statusUnknown'
},
[SendStatus.NOT_MONITORED]: {
icon: 'long-arrow-right',
class: 'statusUnknown'
}
},
push: {
[PushStatus.CONNECTED]: {
icon: 'long-arrow-left',
class: 'statusOk'
},
[PushStatus.DISCONNECTED]: {
icon: 'long-arrow-left',
class: 'statusUnknown'
},
[PushStatus.UNKNOWN]: {
icon: 'long-arrow-left',
class: 'statusUnknown'
},
[PushStatus.MAINTENANCE]: {
icon: 'wrench',
class: 'statusAlert'
}
},
device: {
MAINTENANCE: {
icon: 'wrench',
class: 'statusAlert'
}
}
}
|
tooltips |
Type : object
|
Default value : {
sendStatusConnected: (lastMessage, translateService) => {
const date = formatDate(
new Date(lastMessage),
'medium',
translateService.currentLang || TranslateService.defaultLang()
);
return translateService.instant(gettext('Device last request:\n{{date}}'), { date });
},
sendStatusDisconnected: gettext('Connection not monitored'),
pushStatusConnected: gettext('Connection to device established'),
pushStatusDisconnected: gettext(
'Connection to device not established (not supported by device or no connectivity)'
),
maintenance: gettext('Device is under maintenance')
}
|
deviceListRoutes |
Type : Route[]
|
Default value : [
{
path: 'device',
component: DeviceListComponent
}
]
|
deviceManagementDefaultWidgets |
Default value : [
deviceManagementWelcomeWidgetDefinition,
assetNotesWidgetDefinition
] satisfies DynamicWidgetDefinition[]
|
deviceProfilesRoutes |
Type : Route[]
|
Default value : [
{
path: 'device-profiles/:id',
component: DeviceProfileComponent
},
{
path: 'device-profiles',
component: DeviceProfileListComponent
}
]
|
deviceProtocolRoutes |
Type : Route[]
|
Default value : [
{
path: 'deviceprotocols/opcuaV2/:id',
component: OpcuaDeviceProtocolDetailComponent
}
]
|
opcuaRoutes |
Type : Route[]
|
Default value : [
{
context: ViewContext.Device,
path: 'opcua-servers',
component: OpcuaServersComponent,
label: gettext('OPC UA server'),
icon: 'server',
canActivate: [OpcuaAgentGuard, OpcuaMicroserviceGuard]
},
{
context: ViewContext.Device,
path: 'address-space',
component: OpcuaAddressSpaceComponent,
label: gettext('Address space'),
icon: 'cloud-network',
canActivate: [OpcuaServerGuard, OpcuaMicroserviceGuard]
}
]
|
devicesAndSensorsIconCategory |
Default value : {
label: gettext('Devices and sensors`icons-category`'),
icons: devicesAndSensorsIcons
} as const
|
documentationItems |
Type : DocLinkWithLabel[]
|
Default value : [
{
icon: 'c8y-c8y-data', // double c8y- is correct!
label: gettext('Concepts`KEEP_ORIGINAL`'),
url: '/docs/concepts/introduction',
type: 'doc'
},
{
icon: 'c8y-user',
label: gettext('Getting started`KEEP_ORIGINAL`'),
url: '/docs/sector/getting_started',
type: 'doc'
},
{
icon: 'c8y-administration',
label: gettext('Platform administration`KEEP_ORIGINAL`'),
url: '/docs/sector/platform_administration',
type: 'doc'
},
{
icon: 'c8y-device-management',
label: gettext('Device Management'),
url: '/docs/sector/device_management',
type: 'doc'
},
{
icon: 'c8y-cockpit',
label: gettext('Application enablement`KEEP_ORIGINAL`'),
url: '/docs/sector/app_enablement',
type: 'doc'
},
{
icon: 'c8y-book',
label: gettext('Cumulocity IoT Edge`KEEP_ORIGINAL`'),
url: '/docs/edge/edge-introduction',
type: 'doc'
},
{
icon: 'c8y-data-explorer',
label: gettext('Streaming analytics`KEEP_ORIGINAL`'),
url: '/docs/streaming-analytics/overview-analytics',
type: 'doc'
},
{
icon: 'rest-api',
label: gettext('OpenAPI specification`KEEP_ORIGINAL`'),
url: '/api',
type: 'doc'
},
legalNoticesItem
]
|
legalNoticesItem |
Type : DocLinkWithLabel
|
Default value : {
icon: 'gavel',
label: gettext('Legal notices'),
url: 'https://cumulocity.com/docs/legal-notices/',
type: 'doc'
}
|
downloadEmitter |
Default value : new EventEmitter<string>()
|
DRAWER_ANIMATION_TIME |
Type : number
|
Default value : 400
|
ecommerceIconCategory |
Default value : {
label: gettext('e-commerce`icons-category`'),
icons: ecommerceIcons
} as const
|
editingIconCategory |
Default value : {
label: gettext('Editing`icons-category`'),
icons: editingIcons
} as const
|
ES_MAX_TIME_MILLISECONDS |
Type : number
|
Default value : 8640000000000000
|
The range of times supported by ECMAScript Date objects in milliseconds. |
EVENT_RESERVED_KEYS |
Type : []
|
Default value : [
'creationTime',
'id',
'self',
'source',
'text',
'time',
'type',
'c8y_IsBinary'
]
|
EVENT_STANDARD_KEYS |
Type : object
|
Default value : {
type: gettext('Type'),
text: gettext('Text')
}
|
ExcelGeneratorAdapter |
Type : FileGenerator
|
Default value : {
getLabel: ExcelGenerator.getLabel.bind(ExcelGenerator),
getIcon: ExcelGenerator.getIcon.bind(ExcelGenerator),
getFileExtension: ExcelGenerator.getFileExtension.bind(ExcelGenerator),
getMimeType: ExcelGenerator.getMimeType.bind(ExcelGenerator),
generateMerged: ExcelGenerator.convertToMergedExcel.bind(ExcelGenerator),
getType: ExcelGenerator.getType.bind(ExcelGenerator),
getTitle: ExcelGenerator.getTitle.bind(ExcelGenerator),
getZipName: ExcelGenerator.getZipName.bind(ExcelGenerator),
getAcceptType: ExcelGenerator.getAcceptType.bind(ExcelGenerator)
}
|
EXPORT_MODE_LABELS |
Default value : {
FULL: gettext('Full`export type`') as 'Full',
COMPACT: gettext('Compact`export type`') as 'Compact'
} as const
|
FILE_COMPRESSION_TYPES_VALUES |
Default value : {
store: 'STORE',
deflate: 'DEFLATE'
} as const
|
HAS_ERROR |
Type : string
|
Default value : 'has-error'
|
MEASUREMENTS_PREVIEW_ITEMS_LIMIT |
Type : number
|
Default value : 5
|
SERIES_DATA_MERGED_FILE_NAME |
Type : string
|
Default value : 'seriesDataMergedFileName'
|
exportSchedulesComponentDowngradedComponent |
Default value : downgradeComponent({
component: ExportSchedulesComponent
})
|
extensibleDeviceRegistrationBulkSchema |
Type : object
|
Default value : {
$schema: 'https://json-schema.org/draft/2019-09/schema',
type: 'object',
properties: {
csvBulkFile: {
type: 'array',
title: gettext('CSV file upload'),
description: gettext(
'You can use file upload component to let users send files. This input accepts only a single CSV file.'
),
contentMediaType: 'csv'
}
},
required: ['csvBulkFile'],
additionalProperties: false
}
|
extraCssTabLabel |
Default value : gettext('Custom CSS')
|
extraRoutes |
Type : Route[]
|
Default value : [
{
path: 'users/new',
component: EmptyComponent
}
]
|
viewContextRoutes |
Type : ViewContextRootRoute[]
|
Default value : []
|
fieldbusTypes |
Type : []
|
Default value : [
'actility',
'canbus',
'canopen',
'lora',
'lpwan',
'modbus',
'opcua',
'profibus',
'sigfox'
]
|
protocolRoutes |
Type : Route[]
|
Default value : fieldbusTypes.map(protocol => ({
path: `deviceprotocols/${protocol}/:id`,
component: DeviceTypeDetailComponent,
canDeactivate: [DeviceProtocolsGuard]
}))
|
fieldDateTypeConfig |
Default value : (): EnvironmentProviders =>
importProvidersFrom(
FormlyModule.forChild({
types: [
{
name: 'date',
component: FieldDate
}
]
})
)
|
fieldFileTypeConfig |
Default value : (): EnvironmentProviders =>
importProvidersFrom(
FormlyModule.forChild({
types: [
{
name: 'file',
component: FieldFile
}
]
})
)
|
fieldRadioTypeConfig |
Default value : (): EnvironmentProviders =>
importProvidersFrom(
FormlyModule.forChild({
types: [
{
name: 'radio',
component: FieldRadio,
wrappers: ['c8y-form-field']
}
]
})
)
|
filesAndFoldersIconCategory |
Default value : {
label: gettext('Files and folders`icons-category`'),
icons: filesAndFoldersIcons
} as const
|
financeIconCategory |
Default value : {
label: gettext('Finance`icons-category`'),
icons: financeIcons
} as const
|
FIRMWARE_FRAGMENT |
Type : string
|
Default value : 'c8y_Firmware'
|
SUPPORTED_OPERATIONS_FRAGMENT |
Type : string
|
Default value : 'c8y_SupportedOperations'
|
genericTabName |
Default value : gettext('Generic')
|
lightThemeTabName |
Default value : gettext('Light theme')
|
GRID_CONFIG_KEY |
Type : string
|
Default value : 'device-grid-bulk'
|
handsIconCategory |
Default value : {
label: gettext('Hands`human hands, icons-category`'),
icons: handsIcons
} as const
|
helpAndServiceWidgetProviders |
Type : []
|
Default value : [hookWidget(helpAndServiceWidgetDefinition)]
|
HOOK_ACTION |
Consider using the `hookAction` function instead. |
Default value : new InjectionToken('HOOK_ACTION')
|
A hook to add an action using the multi-provider extension concept. |
HOOK_ACTION_CONTROLS |
Default value : new InjectionToken('ActionControlHook')
|
HOOK_BREADCRUMB |
Consider using the `hookBreadcrumb` function instead. |
Default value : new InjectionToken('HOOK_BREADCRUMB')
|
HOOK_CURRENT_APPLICATION |
Default value : new InjectionToken<IApplication>(
'HOOK_CURRENT_APPLICATION'
)
|
HOOK_CURRENT_TENANT |
Default value : new InjectionToken<IApplication>('HOOK_CURRENT_TENANT')
|
HOOK_CURRENT_USER |
Default value : new InjectionToken<IUser>('HOOK_CURRENT_USER')
|
HOOK_DEVICE_LIST_COLUMNS |
Default value : new InjectionToken<GenericHookType<Column>>(
'HOOK_ALL_DEVICES_LIST_COLUMNS'
)
|
HOOK_DOCS |
Default value : new InjectionToken<DocLinkExtension[]>('HOOK_DOCS')
|
HOOK_DRAWER |
Default value : new InjectionToken<DrawerItem[]>('HOOK_DRAWER')
|
A hook to use for Multi Provider extension.
Consider using the |
HOOK_DYNAMIC_PROVIDER_CONFIG |
Consider using the `hookDynamicProviderConfig` function instead. |
Default value : new InjectionToken('HOOK_DYNAMIC_PROVIDER_CONFIG')
|
HOOK_FILTER_MAPPER |
Default value : new InjectionToken<FilterMapperExtension>('HOOK_FILTER_MAPPER')
|
HOOK_OPTIONS |
Consider using the `hookOptions` function instead. |
Default value : new InjectionToken<ExtensionFactory<ApplicationOptions>>(
'HOOK_OPTIONS'
)
|
HOOK_PATTERN_MESSAGES |
Consider using the `hookPatternMessages` function instead. |
Default value : new InjectionToken('HOOK_PATTERN_MESSAGES')
|
HOOK_PLUGIN |
Only meant for internal usage. |
Default value : new InjectionToken<any>('HOOK_PLUGIN')
|
HOOK_PREVIEW |
Default value : new InjectionToken<PreviewFeature[]>('HOOK_PREVIEW')
|
HOOK_QUERY_PARAM |
Default value : new InjectionToken<QueryParamConfig[]>('HOOK_QUERY_PARAM')
|
HOOK_QUERY_PARAM_BOTTOM_DRAWER |
Default value : new InjectionToken<QueryParamBottomDrawerConfig[]>(
'HOOK_QUERY_PARAM_BOTTOM_DRAWER'
)
|
HOOK_QUERY_PARAM_MODAL |
Default value : new InjectionToken<QueryParamModalConfig[]>(
'HOOK_QUERY_PARAM_MODAL'
)
|
HOOK_ROUTE |
Consider using the `hookRoute` function instead. |
Default value : new InjectionToken<RouteFactory>('HOOK_ROUTE')
|
A hook to use for Multi Provider extension. |
SERVICE_STATUS_OPTIONS |
Type : StatusOption[]
|
Default value : [
{
key: 'up',
label: gettext('Up'),
icon: 'check-circle',
class: 'text-success'
},
{
key: 'down',
label: gettext('Down'),
icon: 'exclamation-circle',
class: 'text-danger'
},
{
key: 'unknown',
label: gettext('Unknown'),
icon: 'inactive-state'
}
]
|
Standard status options supported by the platform. |
HOOK_STEPPER |
Consider using the `hookStepper` function instead. |
Default value : new InjectionToken<StepperExtension[]>('HOOK_STEPPER')
|
A hook to use for Multi Provider extension. |
HOOK_TABS |
Consider using the `hookTab` function instead. |
Default value : new InjectionToken<TabExtension[]>('HOOK_TABS')
|
A hook to use for Multi Provider extension. |
HOOK_USER_MENU |
Default value : new InjectionToken<UserMenuItem[]>('HOOK_USER_MENU')
|
A hook to use for Multi Provider extension.
Consider using the |
VERSION_MODULE_CONFIG |
Default value : new InjectionToken<VersionModuleConfig>(
'VERSION_MODULE_CONFIG'
)
|
HOOK_WIZARD |
Consider using the `hookWizard` function instead. |
Default value : new InjectionToken<WizardExtension[]>('HOOK_WIZARD')
|
A hook to add wizard entries. |
ICONS_MAP |
Type : object
|
Default value : {
ALARM: ICONS.ALARM,
EVENT: ICONS.EVENT,
ACKNOWLEDGED: ICONS.ACKNOWLEDGED,
CLEARED: ICONS.CLEARED,
MINOR: ICONS.MINOR,
MAJOR: ICONS.MAJOR,
CRITICAL: ICONS.CRITICAL,
WARNING: ICONS.WARNING
}
|
imageWidgetProviders |
Type : []
|
Default value : [hookWidget(imageWidgetDefinition)]
|
INDEX_HTML |
Type : string
|
Default value : '/index.html'
|
INFO_GAUGE_COLORS |
Default value : {
GREEN: 'var(--c8y-brand-50)',
YELLOW: 'var(--c8y-palette-status-warning)',
RED: 'var(--c8y-palette-status-danger)'
} as const
|
infoGaugeWidgetProviders |
Type : []
|
Default value : [hookWidget(infoGaugeWidgetDefinition)]
|
INTERVAL_VALUES |
Default value : Object.keys(INTERVAL_TITLES).reduce(
(acc, key) => ({
...acc,
[key]: key
}),
{} as IntervalMap
)
|
INTERVALS |
Type : Interval[]
|
Default value : [
{
id: 'minutes',
title: gettext('Last minute'),
timespanInMs: TimeSpanInMs.MINUTE
},
{
id: 'hours',
title: gettext('Last hour'),
timespanInMs: TimeSpanInMs.HOUR
},
{
id: 'days',
title: gettext('Last day'),
timespanInMs: TimeSpanInMs.DAY
},
{
id: 'weeks',
title: gettext('Last week'),
timespanInMs: TimeSpanInMs.WEEK
},
{
id: 'months',
title: gettext('Last month'),
timespanInMs: TimeSpanInMs.MONTH
},
{ id: 'custom', title: gettext('Custom') }
]
|
todayDate |
Default value : new Date()
|
kpiWidgetProviders |
Type : []
|
Default value : [hookWidget(kpiWidgetDefinition)]
|
LANGUAGES |
Default value : new InjectionToken('Languages')
|
legacyCockpitWelcomeWidgetProviders |
Type : []
|
Default value : [
hookWidget(legacyCockpitWelcomeWidgetDefinition)
]
|
linearGaugeWidgetProviders |
Type : []
|
Default value : [hookWidget(linearGaugeWidgetDefinition)]
|
LOCALE_PATH |
Default value : new InjectionToken('Locale path')
|
LOCATION_UPDATE_EVENT_TYPE |
Type : string
|
Default value : 'c8y_LocationUpdate'
|
locationIconCategory |
Default value : {
label: gettext('Location`icons-category`'),
icons: locationIcons
} as const
|
lpwanRoutes |
Type : Route[]
|
Default value : [
{
context: ViewContext.Device,
path: 'assign-protocol',
component: LpwanAssignDeviceProtocolComponent,
label: gettext('LPWAN'),
icon: 'c8y-device-protocols',
canActivate: [LpwanAgentGuard]
}
]
|
mapWidgetProviders |
Type : []
|
Default value : [hookWidget(mapWidgetDefinition)]
|
markdownWidgetProviders |
Type : []
|
Default value : [hookWidget(markdownWidgetDefinition)]
|
MAX_DEVICE_STORAGE_LIMIT_MiB |
Default value : Math.round(Number.MAX_SAFE_INTEGER / 1024 / 1024)
|
tenantLimitsCustomProperties |
Type : TenantLimit
|
Default value : tenantLimitsCustomPropertiesDefinition
|
MAX_PAGE_SIZE |
Type : number
|
Default value : 2000
|
The maximum pageSize used in API queries to c8y. |
MESSAGES_DATAHUB_I18N |
Type : object
|
Default value : {
'^Offloading task "(.+?)" finished successfully.$': {
gettext: gettext('Offloading task "{{ taskName }}" finished successfully.'),
placeholders: {
taskName: '$1'
}
},
'^Offloading task "(.+?)" finished erroneously.$': {
gettext: gettext('Offloading task "{{ taskName }}" finished erroneously.'),
placeholders: {
taskName: '$1'
}
},
'^Compaction task "(.+?)" finished successfully.$': {
gettext: gettext('Compaction task "{{ taskName }}" finished successfully.'),
placeholders: {
taskName: '$1'
}
},
'^Compaction task "(.+?)" finished erroneously.$': {
gettext: gettext('Compaction task "{{ taskName }}" finished erroneously.'),
placeholders: {
taskName: '$1'
}
}
}
|
Messages required to translate texts of events sent by the datahub microservice. |
messagingIconCategory |
Default value : {
label: gettext('Messaging`icons-category`'),
icons: messagingIcons
} as const
|
minColumnGridTrackSize |
Type : number
|
Default value : 80
|
ratiosByColumnTypes |
Type : object
|
Default value : {
/** The width ration for icon column type. */
icon: 1,
/** The width ration for numeric column type. */
numeric: 1,
/** The width ration for short text column type. */
'text-short': 1.67,
/** The width ration for long text column type. */
'text-long': 3.33
}
|
Maps column types to relative widths. |
MO_TYPES |
Default value : [
'asset',
'dynamicGroup',
'brokerSource',
'brokerSourceInactive',
'group',
'other'
] as const
|
nodeCrypto |
Default value : require('crypto')
|
mockResponse |
Type : object
|
Default value : {
inventoryMOListResponse: [
{
id: '12345',
name: 'Test',
owner: 'user',
creationTime: '2023-03-04',
lastUpdated: '2023-03-04',
self: '',
additionParents: { references: [] },
assetParents: { references: [] },
deviceParents: { references: [] },
childAdditions: { references: [] },
childAssets: { references: [] },
childDevices: { references: [] },
c8y_BrokerSource: {
status: DataBrokerConnectorStatus.SUSPENDED
}
},
{
id: '12346',
name: 'Test',
owner: 'user',
creationTime: '2023-03-04',
lastUpdated: '2023-03-04',
self: '',
additionParents: { references: [] },
assetParents: { references: [] },
deviceParents: { references: [] },
childAdditions: { references: [] },
childAssets: { references: [] },
childDevices: { references: [] },
c8y_BrokerSource: {
status: DataBrokerConnectorStatus.ACTIVE
}
}
],
deviceRegistrationRequestsListResponse: [
{
owner: 'iiar',
customProperties: {
c8y_BrokerSource: {
domain: 'iiar3.basic.stage.c8y.io',
connectorName: 'From iiar3.basic.stage.c8y.io',
connectorDescription: '',
tenant: 't1904475',
status: 'ACTIVE'
}
},
creationTime: '2023-03-01T14:15:56.669Z',
tenantId: 't56293',
self: 'https://t56293.latest.stage.c8y.io/devicecontrol/newDeviceRequests/P46Nh',
id: 'P46Nh',
type: 'c8y_DataBroker',
status: 'PENDING_ACCEPTANCE'
},
{
owner: 'iiar',
customProperties: {
c8y_BrokerSource: {
domain: 'iiar1.basic.stage.c8y.io',
connectorName: 'From iiar1.basic.stage.c8y.io',
connectorDescription: '',
tenant: 't1904476',
status: 'ACTIVE'
}
},
creationTime: '2023-03-01T14:12:56.669Z',
tenantId: 't56293',
self: 'https://t56293.latest.stage.c8y.io/devicecontrol/newDeviceRequests/P46Nh',
id: 'P46Nh',
type: 'c8y_DataBroker',
status: 'WAITING_FOR_CONNECTION'
},
{
owner: 'iiar',
customProperties: {
c8y_BrokerSource: {
domain: 'iiar2.basic.stage.c8y.io',
connectorName: 'From iiar2.basic.stage.c8y.io',
connectorDescription: '',
tenant: 't1904477',
status: 'ACTIVE'
}
},
creationTime: '2023-03-01T14:10:56.669Z',
tenantId: 't56293',
self: 'https://t56293.latest.stage.c8y.io/devicecontrol/newDeviceRequests/P46Nh',
id: 'P46Nh',
type: 'c8y_DataBroker',
status: 'PENDING_ACCEPTANCE'
}
]
}
|
multimediaIconCategory |
Default value : {
label: gettext('Multimedia`icons-category`'),
icons: multimediaIcons
} as const
|
NAME_DATA_BROKER |
Type : string
|
Default value : 'c8y.upgrade.dataBroker'
|
ng1ModulesDataBroker |
Type : []
|
Default value : [NAME_DATA_BROKER]
|
NAME_OPCUA |
Type : string
|
Default value : 'c8y.upgrade.opcua'
|
ng1ModulesOPCUA |
Type : []
|
Default value : [NAME_OPCUA]
|
NAME_REPORTS |
Type : string
|
Default value : 'c8y.upgrade.reports'
|
ng1ModulesReports |
Type : []
|
Default value : [NAME_REPORTS]
|
NAME_UPGRADE |
Type : string
|
Default value : 'c8y.upgrade'
|
ng1ModulesUpgrade |
Type : []
|
Default value : ['app', NAME_UPGRADE]
|
NAMESPACE_PROPS |
Type : Record<string, NamespaceProps>
|
Default value : {
mqtt: {
icon: 'c8y-device-protocols',
label: gettext('MQTT Service')
},
'data-broker-fwd': {
icon: 'c8y-data-broker',
label: gettext('Data Broker')
},
relnotif: {
icon: 'c8y-notification',
label: gettext('Notifications 2.0')
},
'streaming-analytics': {
icon: 'c8y-streaming-analytics',
label: gettext('Streaming Analytics')
}
}
|
Currently known namespaces and their properties. |
NEEDED_ROLE_FOR_SETUP |
Type : string
|
Default value : 'ROLE_APPLICATION_MANAGEMENT_ADMIN'
|
SETUP_FINISHED_STEP_ID |
Type : string
|
Default value : 'c8ySetupFinished'
|
networkIconCategory |
Default value : {
label: gettext('Network`icons-category`'),
icons: networkIcons
} as const
|
NEW_SERVER_ID |
Type : string
|
Default value : 'new'
|
newDashboardTab |
Type : Tab<string>
|
Default value : {
featureId: 'newDashboard',
icon: 'th',
label: gettext('New dashboard'),
path: 'new-dashboard',
// place tab as last one and hide it so it won't be opened until user initiates adding new dashboard
hide: true,
priority: -Infinity
}
|
NULL_VALUE_PLACEHOLDER |
Type : string
|
Default value : '--'
|
NUMBER_FORMAT_REGEXP |
Default value : /^(\d+)?\.((\d+)(-(\d+))?)?$/
|
objectTypeConfig |
Default value : (): EnvironmentProviders =>
importProvidersFrom(
FormlyModule.forChild({
types: [{ name: 'object', component: ObjectTypeComponent }]
})
)
|
officeIconCategory |
Default value : {
label: gettext('Office`icons-category`'),
icons: officeIcons
} as const
|
opcuaAddressSpaceTreeComponentDowngradedComponent |
Default value : downgradeComponent({
component: OpcuaAddressSpaceTreeComponent,
inputs: ['moId'],
outputs: ['selectedNode']
})
|
operationStatusClasses |
Type : object
|
Default value : {
[OperationStatus.PENDING]: 'text-info',
[OperationStatus.EXECUTING]: 'text-info',
[OperationStatus.SUCCESSFUL]: 'text-success',
[OperationStatus.FAILED]: 'text-danger'
}
|
operationStatusIcons |
Type : object
|
Default value : {
[OperationStatus.PENDING]: 'clock-o',
[OperationStatus.EXECUTING]: 'refresh',
[OperationStatus.SUCCESSFUL]: 'check-circle',
[OperationStatus.FAILED]: 'exclamation-circle'
}
|
statusAlert |
Type : object
|
Default value : {
[Status.SUCCESS]: `alert-${Status.SUCCESS}`,
[Status.WARNING]: `alert-${Status.WARNING}`,
[Status.DANGER]: `alert-${Status.DANGER}`,
[Status.INFO]: `alert-${Status.INFO}`
}
|
statusClasses |
Type : object
|
Default value : {
[Status.SUCCESS]: `text-${Status.SUCCESS}`,
[Status.WARNING]: `text-${Status.WARNING}`,
[Status.DANGER]: `text-${Status.DANGER}`,
[Status.INFO]: `text-${Status.INFO}`
}
|
statusIcons |
Type : object
|
Default value : {
[Status.SUCCESS]: 'check-circle',
[Status.WARNING]: 'exclamation-triangle',
[Status.DANGER]: 'exclamation-circle',
[Status.INFO]: 'info-circle'
}
|
peopleIconCategory |
Default value : {
label: gettext('People`icons-category`'),
icons: peopleIcons
} as const
|
platformIconCategory |
Default value : {
label: gettext('Platform`icons-category`'),
icons: platformIcons
} as const
|
PRODUCT_EXPERIENCE_DATA_EXPLORER_AND_GRAPH |
Type : object
|
Default value : {
EVENTS: {
DATA_EXPLORER_AND_GRAPH: 'data-explorer-and-graph'
},
COMPONENTS: {
DATA_EXPLORER_DETAILS: 'data-explorer-details'
},
ACTIONS: {
DATA_EXPLORER_CONFIG_INIT: 'data-explorer-config-init',
DATA_EXPLORER_CONFIG_CHANGE: 'data-explorer-config-change',
DATA_GRAPH_WIDGET_CONFIG: 'data-graph-widget-config'
}
}
|
REALTIME_TEXTS |
Default value : {
ACTIVE: gettext('Realtime active'),
INACTIVE: gettext('Realtime inactive')
} as const
|
PRODUCT_EXPERIENCE_EVENT_SOURCE |
Default value : new InjectionToken('ProductExperienceEventSource')
|
Use this token for components that can provide product experience events. |
PRODUCT_EXPERIENCE_FILE_PREVIEW |
Default value : {
EVENTS: {
FILE_PREVIEW: 'filePreview'
},
COMPONENTS: {
FILE_PREVIEW_COMPONENT: 'file-preview'
},
ACTIONS: {
OPEN_PREVIEW: 'openPreview'
}
} as const
|
PRODUCT_EXPERIENCE_ICON_SELECTOR |
Type : object
|
Default value : {
EVENTS: {
ICON_SELECTOR: 'iconSelector'
},
COMPONENTS: {
ICON_SELECTOR_WRAPPER_COMPONENT: 'icon-selector-wrapper-component'
},
ACTIONS: {
OPEN_ICON_SELECTOR: 'openIconSelector',
ICON_SELECTED: 'iconSelected'
}
}
|
WIDGET_TYPE_VALUES |
Default value : {
ALARMS: 'alarms',
DATA_POINTS_TABLE: 'dataPointsTable'
} as const
|
REPOSITORY_BINARY_TYPES |
Type : object
|
Default value : {
[RepositoryType.SOFTWARE]: 'c8y_SoftwareBinary',
[RepositoryType.FIRMWARE]: 'c8y_FirmwareBinary',
[RepositoryType.CONFIGURATION]: 'c8y_ConfigurationDumpBinary'
}
|
SHOW_CONNECT_SMARTPHONE |
Type : string
|
Default value : 'showConnectSmartphone'
|
TENANTS_MODULE_CONFIG |
Default value : new InjectionToken<TenantsModuleConfig>('TenantsModuleConfig')
|
programmingIconCategory |
Default value : {
label: gettext('Programming`icons-category`'),
icons: programmingIcons
} as const
|
PX_ACTIONS |
Type : object
|
Default value : {
APPLY_FILTER: 'applyFilter',
RESET_FILTER: 'resetFilter',
REMOVE_FILTER: 'removeFilter',
CLEAR_FILTER: 'clearFilter',
CUSTOM_ACTION: 'cutomAction:',
ADD_CUSTOM_COLUMN: 'addCustomColumn',
REMOVE_CUSTOM_COLUMN: 'removeCustomColumn',
REORDER_COLUMNS: 'reorderColumns',
CHANGE_VISIBILITY: 'changeVisibility',
CHANGE_SORTING_ORDER: 'changeSortingOrder',
CHANGE_PAGINATION: 'changePagination',
SELECT_ALL_ITEMS: 'bulk:selectAllItems',
BULK_DELETE: 'bulk:delete',
BULK_EXPORT: 'bulk:export',
BULK_CUSTOM_ACTION: 'bulk:customAction:',
BULK_CANCEL: 'bulk:cancel',
SELECT_ITEM: 'item:select',
EDIT_ITEM: 'item:edit',
DELETE_ITEM: 'item:delete',
EXPORT_ITEM: 'item:export',
CUSTOM_ACTION_ITEM: 'item:customAction:',
RELOAD: 'reload',
SEARCH: 'search',
CLEAR_SEARCH: 'clearSearch'
}
|
PX_EVENT_NAME |
Type : string
|
Default value : 'dataGrid'
|
quickLinksWidgetProviders |
Type : []
|
Default value : [hookWidget(quickLinksWidgetDefinition)]
|
radialGaugeWidgetProviders |
Type : []
|
Default value : [hookWidget(radialGaugeWidgetDefinition)]
|
recentAlarmsWidgetProviders |
Type : []
|
Default value : [hookWidget(recentAlarmsDefinition)]
|
remoteAccessPassthroughProviders |
Type : []
|
Default value : [
hookService('remoteAccessProtocolHook', PassthroughRemoteAccessProtocolProviderService)
]
|
REPLACE_DEVICE_STEP_STATES |
Default value : <const>[
'Pending',
'Executing',
'Skipped',
'Failed',
'Successful'
]
|
REPLACE_DEVICE_STEP_STATES_MAP |
Type : ReplaceDeviceStepStatesMap
|
Default value : {
Pending: {
icon: 'clock-o',
styleClass: 'text-info'
},
Executing: {
icon: 'refresh',
styleClass: 'text-info'
},
Skipped: {
icon: 'skip',
styleClass: 'text-info'
},
Failed: {
icon: 'exclamation-circle',
styleClass: 'text-danger'
},
Successful: {
icon: 'check-circle',
styleClass: 'text-success'
}
}
|
REPORTS_NAVIGATOR_NODE_PRIORITY |
Type : number
|
Default value : 40
|
reportsServiceDowngradedInjectable |
Default value : downgradeInjectable(ReportsService)
|
REQUIRED_IDENTITY_ROLES |
Type : []
|
Default value : [
Permissions.ROLE_IDENTITY_READ,
Permissions.ROLE_IDENTITY_ADMIN
]
|
REQUIRED_INVENTORY_ROLES |
Type : []
|
Default value : [
Permissions.ROLE_INVENTORY_READ,
Permissions.ROLE_INVENTORY_ADMIN
]
|
REQUIRED_MANAGED_OBJECT_ROLES |
Type : []
|
Default value : [
Permissions.ROLE_MANAGED_OBJECT_READ,
Permissions.ROLE_MANAGED_OBJECT_ADMIN
]
|
ResolverServerError |
Type : object
|
Default value : {
403: gettext('Forbidden`403 server error`'),
404: gettext('Not found`404 server error`'),
500: serverError,
503: serverError
}
|
serverError |
Default value : gettext('Internal server error`50X server error`')
|
roleNamesToLabels |
Type : object
|
Default value : {
admins: gettext('Admin User`role`'),
business: gettext('Business User`role`'),
devices: gettext('Device User`role`'),
Manager: gettext('Asset Manager`role`'),
readers: gettext('Reader User`role`')
}
|
rolesServiceProvider |
Type : object
|
Default value : {
provide: Ng1RolesService,
useFactory: RolesServiceFactory,
deps: ['$injector']
}
|
rootComponent |
Type : object
|
Default value : {
template: `
<c8y-bootstrap>
<div id="c8y-legacy-view">
<div ng-view ng-if="vm.widthSet && vm.authState.hasAuth"></div>
</div>
</c8y-bootstrap>`,
controller: c8yUiRootController,
controllerAs: 'vm'
}
|
SEARCH_CONFIG |
Default value : new InjectionToken<SearchConfig>('SearchConfig')
|
securityIconCategory |
Default value : {
label: gettext('Security`icons-category`'),
icons: securityIcons
} as const
|
SERVICE_COMMANDS_MAP |
Type : object
|
Default value : {
START: {
label: gettext('Start'),
command: 'START',
icon: 'play-circle',
styleClass: 'text-success'
},
STOP: {
label: gettext('Stop'),
command: 'STOP',
icon: 'stop-circle',
styleClass: 'text-danger'
},
RESTART: {
label: gettext('Restart'),
command: 'RESTART',
icon: 'refresh',
styleClass: 'text-info'
}
}
|
SERVICE_FRAGMENT |
Type : string
|
Default value : 'c8y_Service'
|
SERVICE_HOOK_TOKENS |
Type : Map<CumulocityServiceRegistry.ExtensionKeys, InjectionToken<any>>
|
Default value : new Map()
|
settingsRoutes |
Type : Route[]
|
Default value : [
{
path: 'connectivitySettings/multiple_lns_connectors_sigfox',
component: SigfoxMultipleLnsConnectorComponent
},
{
path: 'connectivitySettings/multiple_lns_connectors_actility',
component: ActilityMultipleLnsConnectorComponent
},
{
path: 'connectivitySettings/multiple_lns_connectors_loriot',
component: LoriotMultipleLnsConnectorComponent
}
]
|
SHOW_PREVIEW_FEATURES |
Type : string
|
Default value : 'showPreviewFeatures'
|
siloWidgetProviders |
Type : []
|
Default value : [hookWidget(siloWidgetDefinition)]
|
SIMPLE_JSON_PATH_REGEX |
Default value : /^[^.\s]+(\.\S+)*$/
|
SINGLE_OPERATIONS_TAB_CONFIG |
Default value : new InjectionToken<Partial<Tab>>(
'SINGLE_OPERATIONS_TAB_CONFIG'
)
|
smartRulesServiceProvider |
Type : object
|
Default value : {
provide: Ng1SmartRulesService,
useFactory: SmartRulesServiceFactory,
deps: ['$injector']
}
|
smartRulesUpgradeServiceProvider |
Type : object
|
Default value : {
provide: Ng1SmartRulesUpgradeService,
useFactory: SmartRulesUpgradeServiceFactory,
deps: ['$injector']
}
|
TAB_ID |
Type : string
|
Default value : 'advanced'
|
templateTypeConfig |
Type : object
|
Default value : {
[TemplateType.CUSTOM]: {
name: 'CUSTOM',
value: 'CUSTOM',
label: gettext('Custom')
},
[TemplateType.AZURE]: {
name: 'AZURE',
value: 'AZURE',
label: gettext('Azure AD')
},
[TemplateType.KEYCLOAK]: {
name: 'KEYCLOAK',
value: 'KEYCLOAK',
label: gettext('Keycloak')
}
}
|
tenantFormInputsDefinitions |
Type : TenantPropertyDefinition
|
Default value : tenantPropertiesDefinitions
|
tenantPoliciesServiceProvider |
Type : object
|
Default value : {
provide: Ng1TenantPoliciesService,
useFactory: TenantPoliciesFactory,
deps: ['$injector']
}
|
TEST_INJECTION_TOKEN |
Default value : new InjectionToken('TEST')
|
TEST_INJECTION_TOKEN_TWO |
Default value : new InjectionToken('TEST2')
|
threeDRotationWidgetProviders |
Type : []
|
Default value : [hookWidget(threeDRotationWidgetDefinition)]
|
translationEditorAdvancedPath |
Type : string
|
Default value : 'advanced'
|
translationEditorBasePath |
Type : string
|
Default value : 'localization'
|
translationEditorBasicPath |
Type : string
|
Default value : 'basic'
|
transportIconCategory |
Default value : {
label: gettext('Transport`icons-category`'),
icons: transportIcons
} as const
|
trustedCertificatesRedirectRoutes |
Type : Route[]
|
Default value : [
{
path: 'trusted-certificates',
pathMatch: 'full',
redirectTo: 'trusted-certificates/certificates'
}
]
|
trustedCertificatesRoutes |
Type : Route[]
|
Default value : [
{
path: 'trusted-certificates/certificates',
component: TrustedCertificateListComponent,
pathMatch: 'full'
}
]
|
trustedCertificatesSettingsRoutes |
Type : Route[]
|
Default value : [
{
path: 'trusted-certificates/settings',
component: CrlSettingsComponent,
pathMatch: 'full'
}
]
|
typeaheadTypeConfig |
Default value : (): EnvironmentProviders =>
importProvidersFrom(
FormlyModule.forChild({
types: [{ name: 'typeahead', component: TypeaheadTypeComponent }]
})
)
|
UPGRADE_ROUTES |
Type : []
|
Default value : [{ path: '**', component: EmptyComponent }]
|
Default value : PRODUCT_EXPERIENCE_TENANT_MANAGEMENT
|
Default value : PRODUCT_EXPERIENCE_TENANT_MANAGEMENT
|
Default value : PRODUCT_EXPERIENCE_TENANT_MANAGEMENT
|
Default value : PRODUCT_EXPERIENCE_TENANT_MANAGEMENT
|
userInterfaceIconCategory |
Default value : {
label: gettext('User interface`icons-category`'),
icons: userInterfaceIcons
} as const
|
userInventoryRolesServiceProvider |
Type : object
|
Default value : {
provide: Ng1UserInventoryRolesService,
useFactory: UserInventoryRolesFactory,
deps: ['$injector']
}
|
weatherIconCategory |
Default value : {
label: gettext('Weather`icons-category`'),
icons: weatherIcons
} as const
|
weatherIcons |
Default value : [
['sun'],
['sunlight'],
['cloud1'],
['rain'],
['winter'],
['storm'],
['keep-dry', 'umbrella']
] as const satisfies ReadonlyArray<ReadonlyArray<string>>
|
WIDGET_ALERTS_ORDER |
Default value : [
'danger',
'warning',
'info',
'system',
'success'
] as const satisfies ReadonlyArray<AlertType>
|
Order of widget alerts due to alerts severity. |
WILDCARD_SEARCH_FEATURE_KEY |
Type : string
|
Default value : 'ui.search.wildcard'
|
Feature key for wildcard search. |
wrapperFormFieldConfig |
Default value : (): EnvironmentProviders =>
importProvidersFrom(
FormlyModule.forChild({
wrappers: [{ name: 'c8y-form-field', component: WrapperFormField }]
})
)
|
wrapperLegendFieldConfig |
Default value : (): EnvironmentProviders =>
importProvidersFrom(
FormlyModule.forChild({
wrappers: [{ name: 'c8y-legend-wrapper', component: LegendFieldWrapper }]
})
)
|