src/app/features/template-export/template-export.entity.ts
Represents a TemplateExport that can be used to generate PDFs via API, replacing placeholders in the file with data from an entity.
A TemplateExport entity represents the meta-data of a template and can be added and manage by admin users.
No results matching.
Properties |
|
Methods |
|
| description |
Type : string
|
Decorators :
@DatabaseField({label: undefined, dataType: undefined})
|
|
Additional description to guide users |
| Static isInternalEntity |
Type : unknown
|
Default value : true
|
|
Inherited from
Entity
|
| Static label |
Type : unknown
|
Default value : $localize`:TemplateExport:Export Template`
|
|
Inherited from
Entity
|
| Static labelPlural |
Type : unknown
|
Default value : $localize`:TemplateExport:Export Templates`
|
| Static route |
Type : string
|
Default value : "admin/template-export"
|
| targetFileName |
Type : string
|
Decorators :
@DatabaseField({label: undefined, labelShort: undefined, description: undefined, validators: undefined})
|
|
A string with the pattern including placeholders for the file name of the generated files. |
| templateFile |
Type : string
|
Decorators :
@DatabaseField({label: undefined, description: undefined, validators: undefined, dataType: undefined, additional: undefined})
|
|
File (storing the file name) of the template uploaded to the server. |
| templateId |
Type : string
|
Decorators :
@DatabaseField()
|
|
ID of the template file in the server-side managed API. This is not displayed to users - they interact with the templateFile property instead while this templateId is automatically set when the file is uploaded. |
| title |
Type : string
|
Decorators :
@DatabaseField({label: undefined, validators: undefined})
|
|
human-readable label |
| Static toBlockDetailsAttributes |
Type : EntityBlockConfig
|
Default value : {
title: "title",
fields: ["description"],
}
|
|
Inherited from
Entity
|
| Static toStringAttributes |
Type : []
|
Default value : ["title"]
|
|
Inherited from
Entity
|
| 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 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 |
| updated |
Type : UpdateMetadata
|
Decorators :
@DatabaseField({anonymize: 'retain', isInternalField: true})
|
|
Inherited from
Entity
|
| 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
|
import { Entity } from "../../core/entity/model/entity";
import { DatabaseEntity } from "../../core/entity/database-entity.decorator";
import { DatabaseField } from "../../core/entity/database-field.decorator";
import { LongTextDatatype } from "../../core/basic-datatypes/string/long-text.datatype";
import { FileFieldConfig } from "../file/file.datatype";
import { EntityBlockConfig } from "../../core/basic-datatypes/entity/entity-block/entity-block-config";
import { TemplateExportFileDatatype } from "./template-export-file-datatype/template-export-file.datatype";
/**
* Represents a TemplateExport that can be used to generate PDFs via API,
* replacing placeholders in the file with data from an entity.
*
* A TemplateExport entity represents the meta-data of a template and can be added and manage by admin users.
*/
@DatabaseEntity("TemplateExport")
export class TemplateExport extends Entity {
static override label = $localize`:TemplateExport:Export Template`;
static override labelPlural = $localize`:TemplateExport:Export Templates`;
static override toStringAttributes = ["title"];
static override toBlockDetailsAttributes: EntityBlockConfig = {
title: "title",
fields: ["description"],
};
static override route = "admin/template-export";
static override isInternalEntity = true;
/**
* human-readable label
*/
@DatabaseField({
label: $localize`:TemplateExport:Title`,
validators: { required: true },
})
title: string;
/**
* Additional description to guide users
*/
@DatabaseField({
label: $localize`:TemplateExport:Description`,
dataType: LongTextDatatype.dataType,
})
description: string;
/**
* The entity type(s) this template can be used with (i.e. placeholders matching the entity type)
*/
@DatabaseField({
label: $localize`:TemplateExport:Applicable Record Types`,
labelShort: $localize`:TemplateExport:Record Types`,
editComponent: "EditEntityType",
viewComponent: "DisplayEntityType",
isArray: true,
validators: { required: true },
})
applicableForEntityTypes: string[];
/**
* File (storing the file name) of the template uploaded to the server.
*/
@DatabaseField({
label: $localize`:TemplateExport:Template File`,
description: $localize`:TemplateExport:Upload a specially prepared document that contains placeholders, which will be replace with actual data from a specific record when generating a PDF.`,
validators: { required: true },
dataType: TemplateExportFileDatatype.dataType,
additional: {
acceptedFileTypes:
".docx, .doc, .odt, .xlsx, .xls, .ods, .pptx, .ppt, .odp",
} as FileFieldConfig,
})
templateFile: string;
/**
* ID of the template file in the server-side managed API.
*
* This is not displayed to users - they interact with the templateFile property instead
* while this templateId is automatically set when the file is uploaded.
*/
@DatabaseField()
templateId: string;
/**
* A string with the pattern including placeholders for the file name of the generated files.
*/
@DatabaseField({
label: $localize`:TemplateExport:File name pattern for generated file`,
labelShort: $localize`:TemplateExport:File name pattern`,
description: $localize`:TemplateExport:The filename for the resulting file when using this template. You can use the same placeholders here as in the template file itself (e.g. "my-report_{d.name}.pdf").`,
validators: { required: true },
})
targetFileName: string;
}