@things-factory/dataset 6.2.58 → 6.2.61

package/server/service/data-set/data-item-type.ts

@@ -36,25 +36,36 @@ registerEnumType(DataItemStatType, {
 
 @ObjectType({ description: 'Entity for DataItem' })
 export class DataItem {
-  @Field()
+  @Field({ description: 'The name of the data item' })
   name: string
 
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'A description of the data item' })
   description?: string
 
-  @Field({ nullable: true })
+  @Field({
+    nullable: true,
+    description:
+      'Specifies a key name to be used as a property in a JSON-like object, representing a subfield of a dataset record.'
+  })
   tag?: string
 
-  @Field({ nullable: true })
+  @Field({
+    nullable: true,
+    description:
+      'Specifies a grouping identifier for data items with related content, allowing them to be displayed as subgroups within the overall dataset.'
+  })
+  group?: string
+
+  @Field({ nullable: true, description: 'Indicates if the data item is active' })
   active?: boolean
 
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Indicates if the data item is hidden' })
   hidden?: boolean
 
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'The type of the data item' })
   type?: DataItemType
 
-  @Field(type => ScalarObject, { nullable: true })
+  @Field(type => ScalarObject, { nullable: true, description: 'Options associated with the data item type' })
   options?: { [option: string]: any }
 
   @Field({
@@ -63,31 +74,45 @@ export class DataItem {
   })
   stat?: DataItemStatType
 
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'The unit of measurement for the data item' })
   unit?: string
 
-  @Field(type => Int, { nullable: true })
+  @Field(type => Int, { nullable: true, description: 'The maximum number of data values allowed for this field' })
   quota?: number
 
-  @Field(type => ScalarObject, { nullable: true })
+  @Field(type => ScalarObject, {
+    nullable: true,
+    description: 'Specifies the valid ranges and parameters for this data item.'
+  })
   spec?: { [key: string]: any }
 }
 
 @InputType()
 export class DataItemPatch {
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'The name of the data item' })
   name?: string
 
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'A description of the data item' })
   description?: string
 
-  @Field({ nullable: true })
+  @Field({
+    nullable: true,
+    description:
+      'Specifies a key name to be used as a property in a JSON-like object, representing a subfield of a dataset record.'
+  })
   tag?: string
 
-  @Field(type => DataItemType, { nullable: true })
+  @Field({
+    nullable: true,
+    description:
+      'Specifies a grouping identifier for data items with related content, allowing them to be displayed as subgroups within the overall dataset.'
+  })
+  group?: string
+
+  @Field(type => DataItemType, { nullable: true, description: 'The type of the data item' })
   type?: DataItemType
 
-  @Field(type => ScalarObject, { nullable: true })
+  @Field(type => ScalarObject, { nullable: true, description: 'Options associated with the data item type' })
   options?: { [option: string]: any }
 
   @Field({
@@ -96,18 +121,21 @@ export class DataItemPatch {
   })
   stat?: DataItemStatType
 
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'The unit of measurement for the data item' })
   unit?: string
 
-  @Field(type => Int, { nullable: true })
+  @Field(type => Int, { nullable: true, description: 'The maximum number of data values allowed for this field' })
   quota?: number
 
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Indicates if the data item is active' })
   active?: boolean
 
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Indicates if the data item is hidden' })
   hidden?: boolean
 
-  @Field(type => ScalarObject, { nullable: true })
+  @Field(type => ScalarObject, {
+    nullable: true,
+    description: 'Specifies the valid ranges and parameters for this data item.'
+  })
   spec?: { [key: string]: any }
 }

package/server/service/data-set/data-set.ts

@@ -95,34 +95,34 @@ export class DataSetState {
 @ObjectType({ description: 'Entity for DataSet' })
 export class DataSet {
   @PrimaryGeneratedColumn('uuid')
-  @Field(type => ID)
+  @Field(type => ID, { description: 'The unique identifier of the dataset' })
   readonly id: string
 
   @ManyToOne(type => Domain)
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'The domain to which the dataset belongs' })
   domain?: Domain
 
   @RelationId((dataSet: DataSet) => dataSet.domain)
   domainId?: string
 
   @Column()
-  @Field()
+  @Field({ description: 'The name of the dataset' })
   name?: string
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'A description of the dataset' })
   description?: string
 
   @VersionColumn({ nullable: true, default: 1 })
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'The version of the dataset' })
   version?: number = 1
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Indicates whether the dataset is currently active or in use.' })
   active?: boolean
 
   @ManyToOne(type => DataKeySet, { nullable: true })
-  @Field(type => DataKeySet, { nullable: true })
+  @Field(type => DataKeySet, { nullable: true, description: 'The key set used for this dataset' })
   dataKeySet?: DataKeySet
 
   @RelationId((dataSet: DataSet) => dataSet.dataKeySet)
@@ -159,98 +159,124 @@ export class DataSet {
   @Column('simple-json', { nullable: true })
   @Field(type => [ApprovalLineItem], {
     nullable: true,
-    description: 'Approval line for handling OOC issues for that dataset'
+    description: 'Approval line for handling abnormal data occurance issues for that dataset'
   })
   outlierApprovalLine?: ApprovalLineItem[]
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'The type of the dataset' })
   type?: 'manual' | 'automatic' | string
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
+  @Field({
+    nullable: true,
+    description: `Specifies the method of data entry for the dataset. If set to "generated", data entry screens are automatically generated based on the defined data items. For other types, specific entry screens are configured for each type and specified in the "entryView" field.`
+  })
   entryType?: DataSetEntryType
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
+  @Field({
+    nullable: true,
+    description: `Specifies the custom data entry screen or view for the dataset. When "entryType" is not "generated", this field indicates the screen to be used for data entry. When "entryType" is "generated", this field may not apply.`
+  })
   entryView?: string
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
+  @Field({
+    nullable: true,
+    description: `Specifies the method of data monitoring for the dataset. If set to "generated", monitoring screens are automatically generated based on the dataset configuration. For other types, specific monitoring screens are configured for each type and specified in the "monitorView" field.`
+  })
   monitorType?: DataSetMonitorType
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
+  @Field({
+    nullable: true,
+    description: `Specifies the custom data monitoring screen or view for the dataset. When "monitorType" is not "generated", this field indicates the screen to be used for data monitoring. When "monitorType" is "generated", this field may not apply.`
+  })
   monitorView?: string
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
+  @Field({
+    nullable: true,
+    description: `Specifies the method of reporting for the dataset. If set to "generated", report templates are automatically generated based on the dataset configuration. For other types, specific report templates are configured for each type and specified in the "reportView" field.`
+  })
   reportType?: DataSetReportType
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
+  @Field({
+    nullable: true,
+    description: `Specifies the custom report template or view for the dataset. When "reportType" is not "generated", this field indicates the report template or view to be used for reporting. When "reportType" is "generated", this field may not apply.`
+  })
   reportView?: string
 
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'The report template of the dataset' })
   reportTemplate?: string
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
+  @Field({
+    nullable: true,
+    description:
+      'Specifies the intended purpose or role of the dataset within the system. It helps users understand why the dataset was created and guides the specification of data items accordingly. Common use case options may include "QA," "CCP," "SPC," and others.'
+  })
   useCase?: string
 
   @Column('simple-json', { nullable: true })
-  @Field(type => ScalarObject, { nullable: true })
+  @Field(type => ScalarObject, {
+    nullable: true,
+    description:
+      "Specifies the partition keys used to distribute and organize the dataset's data. Partition keys are properties or attributes that determine how data is logically grouped, stored, and retrieved. They enable efficient data management and querying by allowing data to be organized into smaller, manageable partitions or segments."
+  })
   partitionKeys?: { [key: string]: any }
 
   @Column('simple-json', { nullable: true })
-  @Field(type => [DataItem], { nullable: true })
+  @Field(type => [DataItem], { nullable: true, description: 'Data items for the dataset' })
   dataItems: DataItem[]
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'The schedule of the dataset' })
   schedule?: string
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'The timezone of the dataset' })
   timezone?: string
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'Indicates if the dataset requires review' })
   requiresReview?: boolean
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'The schedule ID of the dataset' })
   scheduleId?: string
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'The summary period of the dataset' })
   summaryPeriod?: DataSetSummaryPeriodType
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'The summary schedule of the dataset' })
   summarySchedule?: string
 
   @Column({ nullable: true })
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'The summary schedule ID of the dataset' })
   summaryScheduleId?: string
 
   @CreateDateColumn()
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'The date and time the dataset was created' })
   createdAt?: Date
 
   @UpdateDateColumn()
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'The date and time the dataset was last updated' })
   updatedAt?: Date
 
   @ManyToOne(type => User, { nullable: true })
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'The user who created the dataset' })
   creator?: User
 
   @RelationId((dataSet: DataSet) => dataSet.creator)
   creatorId?: string
 
   @ManyToOne(type => User, { nullable: true })
-  @Field({ nullable: true })
+  @Field({ nullable: true, description: 'The user who last updated the dataset' })
   updater?: User
 
   @RelationId((dataSet: DataSet) => dataSet.updater)

package/translations/en.json

@@ -5,7 +5,6 @@
   "error.dataset not found": "Cannot find dataSet with the given name({dataSetName})",
   "error.summary not supported": "The given dataSet({dataSetName}) does not support reports for {period}",
   "field.appliance": "appliance",
-  "field.review-approval-line": "review approval line",
   "field.assignees": "assignees",
   "field.collected-at": "collected at",
   "field.corrected-at": "corrected at",
@@ -48,7 +47,6 @@
   "field.oos": "out of critical limit",
   "field.options": "options",
   "field.outlier-approval-line": "outlier approval line",
-  "field.requires-review": "requires review",
   "field.partition-keys": "partition keys",
   "field.prev-schedule": "previous schedule",
   "field.quota": "sampling #",
@@ -58,10 +56,13 @@
   "field.report-type": "report type",
   "field.report-view": "report view",
   "field.request-params": "request parameters",
+  "field.requires-review": "requires review",
+  "field.review-approval-line": "review approval line",
   "field.serial-no": "serial #",
   "field.spec": "spec",
   "field.stat-function": "stat func.",
   "field.status": "status",
+  "field.subgroup": "subgroup",
   "field.summary": "summary",
   "field.summary-period": "summary period",
   "field.supervisory-role": "supervisory role",

package/translations/ja.json

@@ -62,6 +62,7 @@
   "field.spec": "明細",
   "field.stat-function": "統計関数",
   "field.status": "状態",
+  "field.subgroup": "サブグループ名",
   "field.summary": "サマリー",
   "field.summary-period": "サマリー周期",
   "field.supervisory-role": "管理者ロール",

package/translations/ko.json

@@ -5,7 +5,6 @@
   "error.dataset not found": "주어진 이름의({dataSetName}) dataSet을 찾을 수 없습니다",
   "error.summary not supported": "주어진 dataSet({dataSetName})은 {period}의 레포트가 지원되지 않습니다",
   "field.appliance": "어플라이언스",
-  "field.review-approval-line": "결재라인",
   "field.assignees": "할당자 목록",
   "field.collected-at": "수집일시",
   "field.corrected-at": "조치 시간",
@@ -48,7 +47,6 @@
   "field.oos": "허용한계 이탈여부",
   "field.options": "선택옵션",
   "field.outlier-approval-line": "이상치 결재라인",
-  "field.requires-review": "검토 요청",
   "field.partition-keys": "파티션 키",
   "field.prev-schedule": "이전 수집계획",
   "field.quota": "샘플수",
@@ -58,10 +56,13 @@
   "field.report-type": "리포트용 화면종류",
   "field.report-view": "리포트용 화면",
   "field.request-params": "요청 매개변수",
+  "field.requires-review": "검토 요청",
+  "field.review-approval-line": "결재라인",
   "field.serial-no": "시리얼번호",
   "field.spec": "명세",
   "field.stat-function": "통계함수",
   "field.status": "상태",
+  "field.subgroup": "서브그룹명",
   "field.summary": "서머리",
   "field.summary-period": "서머리 주기",
   "field.supervisory-role": "관리자 역할",

package/translations/ms.json

@@ -62,6 +62,7 @@
   "field.spec": "spesifikasi",
   "field.stat-function": "fungsi stat.",
   "field.status": "status",
+  "field.subgroup": "Nama subkumpulan",
   "field.summary": "ringkasan",
   "field.summary-period": "tempoh ringkasan",
   "field.supervisory-role": "peranan pengawasan",

package/translations/zh.json

@@ -5,7 +5,6 @@
   "error.dataset not found": "无法找到给定名称的({dataSetName})数据集",
   "error.summary not supported": "给定的数据集({dataSetName})不支持{period}的报告",
   "field.appliance": "应用设备",
-  "field.review-approval-line": "审批线",
   "field.assignees": "分配者列表",
   "field.collected-at": "收集时间",
   "field.corrected-at": "处理时间",
@@ -48,7 +47,6 @@
   "field.oos": "允许限制偏离情况",
   "field.options": "选择选项",
   "field.outlier-approval-line": "异常批准线",
-  "field.requires-review": "需要审查",
   "field.partition-keys": "分区键",
   "field.prev-schedule": "上次收集计划",
   "field.quota": "样本数",
@@ -58,10 +56,13 @@
   "field.report-type": "报告界面类型",
   "field.report-view": "报告界面",
   "field.request-params": "请求参数",
+  "field.requires-review": "需要审查",
+  "field.review-approval-line": "审批线",
   "field.serial-no": "序列号",
   "field.spec": "规格",
   "field.stat-function": "统计函数",
   "field.status": "状态",
+  "field.subgroup": "子组名称",
   "field.summary": "摘要",
   "field.summary-period": "摘要周期",
   "field.supervisory-role": "监管角色",