src/app/core/import/import-metadata.ts
Details of a previously executed import of data saved to the database to keep a history.
No results matching.
Properties |
|
Methods |
|
Accessors |
| config |
Type : ImportSettings
|
Decorators :
@DatabaseField()
|
|
Defined in src/app/core/import/import-metadata.ts:27
|
| ids |
|
renamed to |
Type : string[]
|
Decorators :
@DatabaseField()
|
|
Defined in src/app/core/import/import-metadata.ts:32
|
| Static isInternalEntity |
Type : unknown
|
Default value : true
|
|
Inherited from
Entity
|
| updatedEntities |
Type : { id: string; importDataChanges: ImportDataChange }[]
|
Decorators :
@DatabaseField()
|
|
Defined in src/app/core/import/import-metadata.ts:51
|
|
IDs of the entities that were updated during the import (already existed before the import) and the previous values of those fields that have been overwritten. |
| Static Optional _isCustomizedType |
| todo: This property is no longer used and will be removed in future versions. |
Type : boolean
|
|
Inherited from
Entity
|
|
True if this type's schema has been customized dynamically from the config. |
| _rev |
Type : string
|
Decorators :
@DatabaseField({anonymize: 'retain', isInternalField: true})
|
|
Inherited from
Entity
|
|
internal database doc revision, used to detect conflicts by PouchDB/CouchDB |
| anonymized |
Type : boolean
|
Decorators :
@DatabaseField({anonymize: 'retain', isInternalField: true})
|
|
Inherited from
Entity
|
|
Whether this entity has been anonymized and therefore cannot be re-activated. |
| Static color |
Type : string | ColorMapping[]
|
|
Inherited from
Entity
|
|
color used for to highlight this entity type across the app. Can be either:
|
| created |
Type : UpdateMetadata
|
Decorators :
@DatabaseField({anonymize: 'retain', isInternalField: true})
|
|
Inherited from
Entity
|
| Static DATABASE |
Type : string
|
Default value : "app"
|
|
Inherited from
Entity
|
|
The database where these entities are stored. |
| Static Optional enableUserAccounts |
Type : boolean
|
|
Inherited from
Entity
|
|
Whether to enable user account creation for this entity type. When true, the UI will allow management of user accounts associated with this entity. |
| Static ENTITY_TYPE |
Type : string
|
Default value : "Entity"
|
|
Inherited from
Entity
|
|
The entity's type.
In classes extending Entity this is usually overridden by the class annotation |
| Static hasPII |
Type : boolean
|
Default value : false
|
|
Inherited from
Entity
|
|
whether this entity type can contain "personally identifiable information" (PII) and therefore should follow strict data protection requirements and offer a function to anonymize records. |
| Static icon |
Type : IconName
|
|
Inherited from
Entity
|
|
icon id used for this entity |
| inactive |
Type : boolean
|
Decorators :
@DatabaseField({anonymize: 'retain', isInternalField: true})
|
|
Inherited from
Entity
|
| Static label |
Type : string
|
|
Inherited from
Entity
|
|
human-readable name/label of the entity in the UI |
| Static schema |
Type : EntitySchema
|
|
Inherited from
Entity
|
|
EntitySchema defining property transformations from/to the database.
This is auto-generated from the property annotations see /additional-documentation/how-to-guides/create-a-new-entity-type.html |
| Static Optional toBlockDetailsAttributes |
Type : EntityBlockConfig
|
|
Inherited from
Entity
|
|
Defining which attributes will be displayed in a tooltip on hover when the record is displayed as an entity-block. |
| Static toStringAttributes |
Type : []
|
Default value : ["entityId"]
|
|
Inherited from
Entity
|
|
Defining which attribute values of an entity should be shown in the The default is the ID of the entity ( |
| updated |
Type : UpdateMetadata
|
Decorators :
@DatabaseField({anonymize: 'retain', isInternalField: true})
|
|
Inherited from
Entity
|
| Static create | ||||||
create(contents: Partial<ImportMetadata>)
|
||||||
|
Defined in src/app/core/import/import-metadata.ts:15
|
||||||
|
Parameters :
Returns :
any
|
| assertValid |
assertValid()
|
|
Inherited from
Entity
|
|
Checks if the entity is valid and if the check fails, throws an error explaining the failed check.
Returns :
void
|
| Public copy | ||||||||||
copy(newId: string | boolean)
|
||||||||||
|
Inherited from
Entity
|
||||||||||
|
Deep copy of the entity. The resulting entity will be of the same type as this (taking into account subclassing). All schema field values that are objects or arrays are deep-cloned to avoid shared mutable state between original and copy.
Parameters :
Returns :
unknown
|
| Static createPrefixedId | ||||||||||||
createPrefixedId(type: string, id: string)
|
||||||||||||
|
Inherited from
Entity
|
||||||||||||
|
Create a prefixed id by adding the type prefix if it isn't already part of the given id.
Parameters :
Returns :
string
|
| Static extractEntityIdFromId | ||||||||
extractEntityIdFromId(id: string)
|
||||||||
|
Inherited from
Entity
|
||||||||
|
Extract entityId without prefix.
Parameters :
Returns :
string
|
| Static extractTypeFromId | ||||||||
extractTypeFromId(id: string)
|
||||||||
|
Inherited from
Entity
|
||||||||
|
Extract the ENTITY_TYPE from an id.
Parameters :
Returns :
string
|
| Public getColor |
getColor()
|
|
Inherited from
Entity
|
|
Used by some generic UI components to set the color for the entity instance. Override this method as needed.
Returns :
string
|
| Static getColorWithConditions | ||||||
getColorWithConditions(entity: Entity)
|
||||||
|
Inherited from
Entity
|
||||||
|
Static method to evaluate conditional colors for an entity based on ColorMapping configuration.
Parameters :
Returns :
string
|
| getConstructor |
getConstructor()
|
|
Inherited from
Entity
|
|
Get the class (Entity or the actual subclass of the instance) to call static methods on the correct class considering inheritance
Returns :
EntityConstructor<unknown>
|
| Public getId | ||||||||
getId(withoutPrefix: unknown)
|
||||||||
|
Inherited from
Entity
|
||||||||
|
Returns the id of this entity. Note that an id is final and can't be changed after the object has been instantiated, hence there is no
Parameters :
Returns :
string
the unique id of this entity |
| getSchema |
getSchema()
|
|
Inherited from
Entity
|
|
Get the entity schema of this class
Returns :
EntitySchema
|
| Public getType |
getType()
|
|
Inherited from
Entity
|
|
Returns the type which is used to categorize this entity in the database. Important: Do not overwrite this method! Types are handled internally.
Returns :
string
the entity's type (which is the class name). |
| Public getWarningLevel |
getWarningLevel()
|
|
Inherited from
Entity
|
|
Override getWarningLevel() to define when the entity is in a critical condition and should be color-coded and highlighted in generic components of the UI.
Returns :
WarningLevel
|
| date |
getdate()
|
|
Defined in src/app/core/import/import-metadata.ts:19
|
| user |
getuser()
|
|
Defined in src/app/core/import/import-metadata.ts:23
|
| createdEntities | ||||||
getcreatedEntities()
|
||||||
|
Defined in src/app/core/import/import-metadata.ts:37
|
||||||
|
IDs of the entities that were created during the import.
Returns :
string[]
|
||||||
setcreatedEntities(ids: string[])
|
||||||
|
Defined in src/app/core/import/import-metadata.ts:41
|
||||||
|
Parameters :
Returns :
void
|
import { DatabaseEntity } from "../entity/database-entity.decorator";
import { Entity } from "../entity/model/entity";
import { DatabaseField } from "../entity/database-field.decorator";
import { ColumnMapping } from "./column-mapping";
import { AdditionalImportAction } from "./additional-actions/additional-import-action";
import { ImportAdditionalSettings } from "./import-additional-settings";
/**
* Details of a previously executed import of data saved to the database to keep a history.
*/
@DatabaseEntity("ImportMetadata")
export class ImportMetadata extends Entity {
static override isInternalEntity = true;
static create(contents: Partial<ImportMetadata>) {
return Object.assign(new ImportMetadata(), contents);
}
get date(): Date {
return this.created?.at;
}
get user(): string {
return this.created?.by;
}
@DatabaseField() config: ImportSettings;
/**
* @deprecated renamed to `createdEntities`
*/
@DatabaseField() ids: string[];
/**
* IDs of the entities that were created during the import.
*/
@DatabaseField() get createdEntities(): string[] {
return this._createdEntities ?? this.ids;
}
set createdEntities(ids: string[]) {
this._createdEntities = ids;
}
private _createdEntities: string[];
/**
* IDs of the entities that were updated during the import (already existed before the import)
* and the previous values of those fields that have been overwritten.
*/
@DatabaseField() updatedEntities: {
id: string;
importDataChanges: ImportDataChange;
}[];
}
/**
* Changes documented for a possible undo of an import.
*/
export interface ImportDataChange {
[field: string]: { previousValue: any; importedValue: any };
}
/**
* Settings for matching imported data to existing records.
*/
export interface ImportExistingSettings {
/** IDs of fields used to match imported data to an existing record */
matchExistingByFields?: string[];
/** Use strict (case-sensitive) matching for existing records */
strictMatching?: boolean;
}
/**
* Settings required to execute an import including type and mappings.
*/
export interface ImportSettings {
entityType: string;
columnMapping: ColumnMapping[];
/** configured actions to run in addition to the import to link data */
additionalActions?: AdditionalImportAction[];
/** settings for matching imported data to existing records */
importExisting?: ImportExistingSettings;
/** additional settings for parsing import data */
additionalSettings?: ImportAdditionalSettings;
filename?: string;
}