Document
Document
Description
L'entité Document permet la gestion des documents. Ceux-ci sont classés par type.
Relations
Ascendantes
Entité | Propriété |
|---|---|
Project | documents |
Descendantes
Entité | Propriété |
|---|---|
History | history |
Liste des propriétés
Nom | Type | DerniÚre version modifiée | Description | Getter | Setter | Deprecated |
|---|---|---|---|---|---|---|
createdAt | Date | ï»ż | Date de crĂ©ation de l'entitĂ© Document | getDocumentCreatedAt | Lecture seule | - |
createdBy | String | ï»ż | Utilisateur Ă l'origine de la crĂ©ation de l'entitĂ© Document | getDocumentCreatedBy | Lecture seule | - |
externalId | String | 2.1.1 | Identifiant du document sur File Storage | getDocumentExternalId | setDocumentExternalId | - |
fileName | String | 2.1.1 | Nom du fichier | getDocumentFileName | setDocumentFileName | - |
fileType | String | 2.1.1 | Type du fichier | getDocumentFileType | setDocumentFileType | - |
hasBeenChecked | Boolean | 2.6.0 | Permet de savoir si le document a été lu. | getDocumentHasBeenChecked | setDocumentHasBeenChecked | - |
id | String | ï»ż | Identifiant unique de l'entitĂ© Document | getDocumentId | Lecture seule | - |
isSignedDocument | Boolean | 2.1.1 | Document signé | getDocumentIsSignedDocument | setDocumentIsSignedDocument | - |
key | String | 2.1.1 | Clé du document | getDocumentKey | setDocumentKey | - |
metadata | String | 2.1.1 | Métadonnées du document | getDocumentMetadata | setDocumentMetadata | - |
mimeType | String | 2.3.0 | Type mime du fichier | getDocumentMimeType | setDocumentMimeType | - |
type | documentTypeEnum | 2.15.0 | Type du document | getDocumentType | setDocumentType | - |
updatedAt | Date | ï»ż | Date de modification de l'entitĂ© Document | getDocumentUpdatedAt | Lecture seule | - |
updatedBy | String | ï»ż | Utilisateur Ă l'origine de la modification de l'entitĂ© Document | getDocumentUpdatedBy | Lecture seule | - |
Enums
documentTypeEnum
- documentTypeEnum.AFFILIATION_CERTIFICATE
- documentTypeEnum.BANKACCOUNTDETAILS
- documentTypeEnum.CANCELLATION_LETTER
- documentTypeEnum.CONTRACT
- documentTypeEnum.DRIVINGLICENSE
- documentTypeEnum.IDCARD
- documentTypeEnum.IPID
- documentTypeEnum.KBIS
- documentTypeEnum.MANDATE
- documentTypeEnum.OTHER
- documentTypeEnum.PASSPORT
- documentTypeEnum.QUOTE
- documentTypeEnum.SEPA
- documentTypeEnum.RESIDENCE_CERTIFICATE
- documentTypeEnum.MADELIN_CERTIFICATE
- documentTypeEnum.SIRENE_NOTICE
- documentTypeEnum.RNM
- documentTypeEnum.RNA
- documentTypeEnum.CHEQUE_SCAN
- documentTypeEnum.WAIVER
- documentTypeEnum.FREE_CLAUSE
- documentTypeEnum.POLITICALLY_EXPOSED_PERSON_PROOF
- documentTypeEnum.MANUAL_SIGNED_CONTRACT_PROPOSAL
- documentTypeEnum.CONTRIBUTIONS_PAYMENT
- documentTypeEnum.SIGNING_AUTHORITY
- documentTypeEnum.ASSOCIATION_RECEIPT
- documentTypeEnum.SIGNED_ADVICE_AND_INFORM_SHEET
- documentTypeEnum.GRANTEE_PRE_REGISTRATION
- documentTypeEnum.EMPLOYEE_REGISTRATION
- documentTypeEnum.TNS_CERTIFICATE
- documentTypeEnum.HANDICAP_CERTIFICATE
- documentTypeEnum.MANDATORY_REGIME_CERTIFICATE
- documentTypeEnum.SCHOOL_CERTIFICATE
- documentTypeEnum.MEMBERSHIP_CERTIFICATE
- documentTypeEnum.HEALTH_INSURANCE_TERMINATION_CERTIFICATE
- documentTypeEnum.RESIDENCE_CARD
- documentTypeEnum.PERMANENT_RESIDENCE_CARD
- documentTypeEnum.VISA
- documentTypeEnum.SPECIFIC_CONDITIONS_MANDATORY_CONTRACT
- documentTypeEnum.SPECIFIC_CONDITIONS_OPTIONAL_CONTRACT
- documentTypeEnum.SPECIFIC_CONDITIONS
- documentTypeEnum.ENROLLMENT_CERTIFICATE
- documentTypeEnum.GENERAL_CONDITIONS_MANDATORY_CONTRACT
- documentTypeEnum.GENERAL_CONDITIONS_OPTIONAL_CONTRACT
- documentTypeEnum.GENERAL_CONDITIONS
- documentTypeEnum.POLICY_INFORMATION_DOCUMENT
- documentTypeEnum.CUSTOMIZED_COVERAGE_TABLE_MANDATORY_CONTRACT
- documentTypeEnum.CUSTOMIZED_COVERAGE_TABLE_OPTIONAL_CONTRACT
- documentTypeEnum.CUSTOMIZED_COVERAGE_TABLE
- documentTypeEnum.CONTRACT_PROPOSAL
- documentTypeEnum.ADVICE_AND_INFORM_SHEET
- documentTypeEnum.ASSISTANCE_NOTICE_GENERAL_CONDITIONS
- documentTypeEnum.HEALTH_INFORMATION_NOTICE
- documentTypeEnum.POLICY_INFORMATION_NOTICE
Exemple
import { Entities } from '@fasstech/oip-core';
import { getDocumentExternalId, getDocumentFileName, getDocumentFileType, getDocumentHasBeenChecked, getDocumentIsSignedDocument, getDocumentKey, getDocumentMetadata, getDocumentMimeType, getDocumentType, getdocumentId, setDocumentExternalId, setDocumentFileName, setDocumentFileType, setDocumentHasBeenChecked, setDocumentIsSignedDocument, setDocumentKey, setDocumentMetadata, setDocumentMimeType, setDocumentType } from '@fasstech/oip-core/entities/document';
import { documentTypeEnum } from '@fasstech/oip-core/entities/document/enums';
import { getProjectId } from '@fasstech/oip-core/entities/project';
(async () => {
let ProjectEntity = await Entities('Project').get({ id: projectId });
const DocumentEntity = await Entities('Document').create();
setDocumentExternalId('externalId', DocumentEntity);
setDocumentFileName('fileName', DocumentEntity);
setDocumentFileType('fileType', DocumentEntity);
setDocumentHasBeenChecked(true, DocumentEntity);
setDocumentIsSignedDocument(false, DocumentEntity);
setDocumentKey('key', DocumentEntity);
setDocumentMetadata('metadata', DocumentEntity);
setDocumentMimeType('mimeType', DocumentEntity);
setDocumentType(documentTypeEnum.CONTRACT_PROPOSAL, DocumentEntity);
ProjectEntity = await Entities('Document').save(ProjectEntity, DocumentEntity);
await Entities('Project').save(ProjectEntity);
const ProjectEntityToTest = await Entities('Project').get({ id: getProjectId(ProjectEntity) });
const DocumentEntityToTest = await Entities('Document').get(ProjectEntityToTest, getDocumentId(DocumentEntity));
getDocumentExternalId(DocumentEntityToTest); // 'externalId'
getDocumentFileName(DocumentEntityToTest); // 'fileName'
getDocumentFileType(DocumentEntityToTest); // 'fileType'
getDocumentHasBeenChecked(DocumentEntityToTest); // true
getDocumentIsSignedDocument(DocumentEntityToTest); // false
getDocumentKey(DocumentEntityToTest); // 'key'
getDocumentMetadata(DocumentEntityToTest); // 'metadata'
getDocumentMimeType(DocumentEntityToTest); // 'mimeType'
getDocumentType(DocumentEntityToTest); // documentTypeEnum.CONTRACT_PROPOSAL
})();