@things-factory/integration-headless 7.0.40 → 7.0.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/dist-server/engine/connector/headless-connector.d.ts +1 -0
  2. package/dist-server/engine/connector/headless-connector.js +3 -0
  3. package/dist-server/engine/connector/headless-connector.js.map +1 -1
  4. package/dist-server/engine/task/headless-pdf-capture-board.js +1 -1
  5. package/dist-server/engine/task/headless-pdf-capture-board.js.map +1 -1
  6. package/dist-server/engine/task/headless-pdf-save.js +34 -19
  7. package/dist-server/engine/task/headless-pdf-save.js.map +1 -1
  8. package/dist-server/tsconfig.tsbuildinfo +1 -1
  9. package/helps/integration/connector/headless-connector.ja.md +71 -0
  10. package/helps/integration/connector/headless-connector.ko.md +72 -0
  11. package/helps/integration/connector/headless-connector.md +71 -0
  12. package/helps/integration/connector/headless-connector.ms.md +73 -0
  13. package/helps/integration/connector/headless-connector.zh.md +71 -0
  14. package/helps/integration/task/headless-pdf-capture-board.ja.md +51 -0
  15. package/helps/integration/task/headless-pdf-capture-board.ko.md +51 -0
  16. package/helps/integration/task/headless-pdf-capture-board.md +51 -0
  17. package/helps/integration/task/headless-pdf-capture-board.ms.md +53 -0
  18. package/helps/integration/task/headless-pdf-capture-board.zh.md +51 -0
  19. package/helps/integration/task/headless-pdf-capture.ja.md +45 -0
  20. package/helps/integration/task/headless-pdf-capture.ko.md +45 -0
  21. package/helps/integration/task/headless-pdf-capture.md +45 -0
  22. package/helps/integration/task/headless-pdf-capture.ms.md +47 -0
  23. package/helps/integration/task/headless-pdf-capture.zh.md +45 -0
  24. package/helps/integration/task/headless-pdf-open.ja.md +55 -0
  25. package/helps/integration/task/headless-pdf-open.ko.md +55 -0
  26. package/helps/integration/task/headless-pdf-open.md +55 -0
  27. package/helps/integration/task/headless-pdf-open.ms.md +57 -0
  28. package/helps/integration/task/headless-pdf-open.zh.md +55 -0
  29. package/helps/integration/task/headless-pdf-save.ja.md +23 -0
  30. package/helps/integration/task/headless-pdf-save.ko.md +25 -0
  31. package/helps/integration/task/headless-pdf-save.md +23 -0
  32. package/helps/integration/task/headless-pdf-save.ms.md +23 -0
  33. package/helps/integration/task/headless-pdf-save.zh.md +23 -0
  34. package/package.json +5 -4
  35. package/server/engine/connector/headless-connector.ts +4 -0
  36. package/server/engine/task/headless-pdf-capture-board.ts +1 -1
  37. package/server/engine/task/headless-pdf-save.ts +41 -18
  38. package/translations/en.json +1 -0
  39. package/translations/ko.json +1 -0
@@ -0,0 +1,71 @@
1
+ ### ヘッドレスプールコネクタ (Headless Pool Connector)
2
+
3
+ **ヘッドレスプールコネクタ**は、ヘッドレスブラウザインスタンスのプールを管理するために設計されています。このコネクタは、PDFの生成やウェブスクレイピングのように、複数のヘッドレスブラウザセッションを同時に実行する必要がある作業に便利です。このコネクタは、これらのヘッドレスブラウザインスタンスの作成、使用、および破棄を効率的に管理します。
4
+
5
+ #### エンドポイント
6
+
7
+ `ヘッドレスプールコネクタ`は特定のエンドポイントを要求しませんが、接続設定の一環としてURIを提供できます。このURIは通常プレースホルダーとして使用され、プールが内部的に実際の接続を処理します。つまり、エンドポイントには任意の文字列を入力することができます。
8
+
9
+ #### パラメータ
10
+
11
+ - **min** (数字):
12
+ - プール内で維持する最小のヘッドレスブラウザインスタンスの数を指定します。
13
+ - デフォルト値: `2`
14
+ - **max** (数字):
15
+ - プールが処理できる最大のヘッドレスブラウザインスタンスの数を指定します。
16
+ - デフォルト値: `10`
17
+
18
+ これらのパラメータは、予想される作業負荷に応じてプールのサイズを調整できるようにします。例えば、アプリケーションが同時に複数のブラウザインスタンスを頻繁に必要とする場合、`max`値を増やすことができます。
19
+
20
+ #### 設定例
21
+
22
+ ```json
23
+ {
24
+ "name": "headless-browser-pool",
25
+ "connector": "headless-connector",
26
+ "endpoint": "1",
27
+ "params": {
28
+ "min": 5,
29
+ "max": 20
30
+ }
31
+ }
32
+ ```
33
+
34
+ 上記の例では、プールは少なくとも5つのヘッドレスブラウザインスタンスを維持し、必要に応じて最大20インスタンスまで拡張することができます。
35
+
36
+ #### 接続ライフサイクル
37
+
38
+ - **connect**:
39
+
40
+ - 接続を初期化し、設定されたパラメータ(`min`および`max`)に従ってヘッドレスブラウザインスタンスのプールを作成します。
41
+ - プールはこれらのインスタンスのライフサイクルを自動的に管理し、必要に応じて新しいインスタンスを作成し、既存のインスタンスを再利用します。
42
+
43
+ - **disconnect**:
44
+ - ヘッドレスブラウザプールを破棄し、すべてのインスタンスが適切に終了し、リソースが解放されるようにします。
45
+
46
+ #### 使用シナリオ
47
+
48
+ `ヘッドレスプールコネクタ`は、ヘッドレスブラウザ環境で作業を実行する必要があるシナリオで主に使用されます。例えば、HTMLコンテンツからPDFを生成したり、ウェブページのスクリーンショットをキャプチャしたり、ウェブサイトからデータをスクレイピングする際に便利です。
49
+
50
+ #### サポートするタスク
51
+
52
+ `ヘッドレスプールコネクタ`は `headless-pdf` プレフィックスの付いたタスクをサポートします。これらのタスクは、このコネクタが管理するヘッドレスブラウザインスタンスを使用します。
53
+
54
+ #### タスクでの使用例
55
+
56
+ ```json
57
+ {
58
+ "name": "generate-pdf",
59
+ "taskType": "headless-pdf-capture",
60
+ "params": {
61
+ "accessor": "data",
62
+ "htmlContent": "<html>...</html>",
63
+ "format": "A4",
64
+ "printBackground": true
65
+ }
66
+ }
67
+ ```
68
+
69
+ #### 説明
70
+
71
+ **ヘッドレスプールコネクタ**は、PDF生成やウェブスクレイピングなどの作業を効率的に実行するために、ヘッドレスブラウザインスタンスのプールを管理し、高負荷なシナリオでのリソース利用の最適化と拡張性を保証します。
@@ -0,0 +1,72 @@
1
+ ### 헤드리스 풀 커넥터 (Headless Pool Connector)
2
+
3
+ **헤드리스 풀 커넥터**는 헤드리스 브라우저 인스턴스의 풀(pool)을 관리하기 위해 설계되었습니다. 이 커넥터는 PDF 생성이나 웹 스크래핑과 같이 여러 개의 헤드리스 브라우저 세션이 동시에 필요한 작업을 수행할 때 유용합니다. 이 커넥터는 이 헤드리스 브라우저 인스턴스의 생성, 사용 및 파기를 효율적으로 관리합니다.
4
+
5
+ #### 엔드포인트
6
+
7
+ `헤드리스 풀 커넥터`는 특정 엔드포인트를 요구하지 않지만, 연결 설정의 일환으로 URI를 제공할 수 있습니다. 이 URI는 일반적으로 플레이스홀더로 사용되며, 풀은 내부적으로 실제 연결을 처리합니다.
8
+ 즉, 엔트포인트는 임의의 문자열을 입력하시면 됩니다.
9
+
10
+ #### 매개변수
11
+
12
+ - **min** (숫자):
13
+ - 풀에서 유지할 최소 헤드리스 브라우저 인스턴스 수를 지정합니다.
14
+ - 기본값: `2`
15
+ - **max** (숫자):
16
+ - 풀이 처리할 수 있는 최대 헤드리스 브라우저 인스턴스 수를 지정합니다.
17
+ - 기본값: `10`
18
+
19
+ 이 매개변수들은 예상되는 작업 부하에 맞춰 풀 크기를 조정할 수 있게 해줍니다. 예를 들어, 애플리케이션에서 여러 브라우저 인스턴스를 자주 동시에 필요로 하는 경우 `max` 값을 늘릴 수 있습니다.
20
+
21
+ #### 설정 예시
22
+
23
+ ```json
24
+ {
25
+ "name": "headless-browser-pool",
26
+ "connector": "headless-connector",
27
+ "endpoint": "1",
28
+ "params": {
29
+ "min": 5,
30
+ "max": 20
31
+ }
32
+ }
33
+ ```
34
+
35
+ 위 예시에서 풀은 최소 5개의 헤드리스 브라우저 인스턴스를 유지하며, 필요에 따라 최대 20개의 인스턴스로 확장할 수 있습니다.
36
+
37
+ #### 연결 생명주기
38
+
39
+ - **connect**:
40
+
41
+ - 연결을 초기화하여 설정된 매개변수(`min` 및 `max`)에 따라 헤드리스 브라우저 인스턴스 풀을 생성합니다.
42
+ - 풀은 이러한 인스턴스들의 생명주기를 자동으로 관리하며, 필요한 경우 새로운 인스턴스를 생성하고 기존 인스턴스를 재사용합니다.
43
+
44
+ - **disconnect**:
45
+ - 헤드리스 브라우저 풀을 파기하여 모든 인스턴스가 적절히 종료되고 리소스가 해제되도록 합니다.
46
+
47
+ #### 사용 시나리오
48
+
49
+ `헤드리스 풀 커넥터`는 헤드리스 브라우저 환경에서 작업을 수행해야 하는 시나리오에서 주로 사용됩니다. 예를 들어, HTML 콘텐츠로부터 PDF를 생성하거나, 웹 페이지의 스크린샷을 캡처하거나, 웹사이트에서 데이터를 스크래핑할 때 유용합니다.
50
+
51
+ #### 지원하는 작업
52
+
53
+ `헤드리스 풀 커넥터`는 `headless-pdf` 접두사가 붙은 작업을 지원합니다. 이러한 작업은 이 커넥터가 관리하는 헤드리스 브라우저 인스턴스를 사용하게 됩니다.
54
+
55
+ #### 작업에서의 예시 사용
56
+
57
+ ```json
58
+ {
59
+ "name": "generate-pdf",
60
+ "taskType": "headless-pdf-capture",
61
+ "params": {
62
+ "accessor": "data",
63
+ "htmlContent": "<html>...</html>",
64
+ "format": "A4",
65
+ "printBackground": true
66
+ }
67
+ }
68
+ ```
69
+
70
+ #### 설명
71
+
72
+ **헤드리스 풀 커넥터**는 PDF 생성 및 웹 스크래핑과 같은 작업을 수행하기 위해 헤드리스 브라우저 인스턴스 풀을 효율적으로 관리하며, 높은 수요가 있는 시나리오에서 자원 활용의 최적화와 확장성을 보장합니다.
@@ -0,0 +1,71 @@
1
+ ### Headless Pool Connector
2
+
3
+ **Headless Pool Connector** is designed to manage a pool of headless browser instances. This connector is useful when performing tasks that require multiple headless browser sessions simultaneously, such as PDF generation or web scraping. It efficiently manages the creation, use, and destruction of these headless browser instances.
4
+
5
+ #### Endpoint
6
+
7
+ `Headless Pool Connector` does not require a specific endpoint, but a URI can be provided as part of the connection setup. This URI is typically used as a placeholder, with the pool handling the actual connection internally. In other words, any string can be entered as the endpoint.
8
+
9
+ #### Parameters
10
+
11
+ - **min** (number):
12
+ - Specifies the minimum number of headless browser instances to maintain in the pool.
13
+ - Default value: `2`
14
+ - **max** (number):
15
+ - Specifies the maximum number of headless browser instances the pool can handle.
16
+ - Default value: `10`
17
+
18
+ These parameters allow the pool size to be adjusted based on the expected workload. For example, if the application frequently requires multiple browser instances simultaneously, the `max` value can be increased.
19
+
20
+ #### Example Configuration
21
+
22
+ ```json
23
+ {
24
+ "name": "headless-browser-pool",
25
+ "connector": "headless-connector",
26
+ "endpoint": "1",
27
+ "params": {
28
+ "min": 5,
29
+ "max": 20
30
+ }
31
+ }
32
+ ```
33
+
34
+ In the example above, the pool maintains at least 5 headless browser instances and can scale up to 20 instances as needed.
35
+
36
+ #### Connection Lifecycle
37
+
38
+ - **connect**:
39
+
40
+ - Initializes the connection and creates the pool of headless browser instances based on the configured parameters (`min` and `max`).
41
+ - The pool automatically manages the lifecycle of these instances, creating new ones as needed and reusing existing ones.
42
+
43
+ - **disconnect**:
44
+ - Destroys the headless browser pool, ensuring all instances are properly terminated and resources are released.
45
+
46
+ #### Usage Scenarios
47
+
48
+ `Headless Pool Connector` is primarily used in scenarios where tasks need to be executed in a headless browser environment. For example, it is useful for generating PDFs from HTML content, capturing screenshots of web pages, or scraping data from websites.
49
+
50
+ #### Supported Tasks
51
+
52
+ `Headless Pool Connector` supports tasks prefixed with `headless-pdf`. These tasks will utilize the headless browser instances managed by this connector.
53
+
54
+ #### Example Usage in Tasks
55
+
56
+ ```json
57
+ {
58
+ "name": "generate-pdf",
59
+ "taskType": "headless-pdf-capture",
60
+ "params": {
61
+ "accessor": "data",
62
+ "htmlContent": "<html>...</html>",
63
+ "format": "A4",
64
+ "printBackground": true
65
+ }
66
+ }
67
+ ```
68
+
69
+ #### Description
70
+
71
+ **Headless Pool Connector** efficiently manages the pool of headless browser instances to execute tasks like PDF generation and web scraping, ensuring optimization and scalability of resources in high-demand scenarios.
@@ -0,0 +1,73 @@
1
+ ### Penyambung Kolam Tanpa Kepala (Headless Pool Connector)
2
+
3
+ **Penyambung Kolam Tanpa Kepala** direka untuk menguruskan kolam contoh pelayar tanpa kepala. Penyambung ini berguna apabila menjalankan tugas yang memerlukan beberapa sesi pelayar tanpa kepala secara serentak seperti penjanaan PDF atau pengikisan web. Penyambung ini menguruskan penciptaan, penggunaan, dan pemusnahan contoh pelayar tanpa kepala dengan cekap.
4
+
5
+ #### Titik Akhir
6
+
7
+ `Penyambung Kolam Tanpa Kepala` tidak memerlukan titik akhir tertentu, tetapi URI boleh disediakan sebagai sebahagian daripada tetapan sambungan. URI ini biasanya digunakan sebagai tempat letak sementara, dan kolam akan mengendalikan sambungan sebenar secara dalaman. Dengan kata lain, sebarang rentetan boleh dimasukkan sebagai titik akhir.
8
+
9
+ #### Parameter
10
+
11
+ - **min** (nombor):
12
+ - Menentukan bilangan minimum contoh pelayar tanpa kepala yang dikekalkan dalam kolam.
13
+ - Nilai lalai: `2`
14
+ - **max** (nombor):
15
+ - Menentukan bilangan maksimum contoh pelayar tanpa kepala yang boleh diuruskan oleh kolam.
16
+ - Nilai lalai: `10`
17
+
18
+ Parameter ini membolehkan saiz kolam disesuaikan berdasarkan beban kerja yang dijangkakan. Sebagai contoh, jika aplikasi sering memerlukan beberapa contoh pelayar serentak, nilai `max` boleh ditingkatkan.
19
+
20
+ #### Contoh Tetapan
21
+
22
+ ```json
23
+ {
24
+ "name": "headless-browser-pool",
25
+ "connector": "headless-connector",
26
+ "endpoint": "1",
27
+ "params": {
28
+ "min": 5,
29
+ "max": 20
30
+ }
31
+ }
32
+ ```
33
+
34
+ Dalam contoh di atas, kolam akan mengekalkan sekurang-kurangnya 5 contoh pelayar tanpa kepala dan boleh berkembang kepada maksimum 20 contoh
35
+
36
+ apabila diperlukan.
37
+
38
+ #### Kitaran Hidup Sambungan
39
+
40
+ - **connect**:
41
+
42
+ - Menginisialisasi sambungan dan mencipta kolam contoh pelayar tanpa kepala mengikut parameter yang ditetapkan (`min` dan `max`).
43
+ - Kolam akan menguruskan kitaran hidup contoh-contoh ini secara automatik, mencipta contoh baru jika diperlukan, dan menggunakan semula contoh sedia ada.
44
+
45
+ - **disconnect**:
46
+ - Menghancurkan kolam pelayar tanpa kepala dan memastikan semua contoh ditutup dengan betul dan sumber dilepaskan.
47
+
48
+ #### Senario Penggunaan
49
+
50
+ `Penyambung Kolam Tanpa Kepala` terutamanya digunakan dalam senario di mana tugas perlu dijalankan dalam persekitaran pelayar tanpa kepala. Contohnya, ia berguna untuk menjana PDF daripada kandungan HTML, menangkap tangkapan skrin halaman web, atau mengikis data daripada laman web.
51
+
52
+ #### Tugas yang Disokong
53
+
54
+ `Penyambung Kolam Tanpa Kepala` menyokong tugas yang bermula dengan awalan `headless-pdf`. Tugas-tugas ini akan menggunakan contoh pelayar tanpa kepala yang diuruskan oleh penyambung ini.
55
+
56
+ #### Contoh Penggunaan dalam Tugas
57
+
58
+ ```json
59
+ {
60
+ "name": "generate-pdf",
61
+ "taskType": "headless-pdf-capture",
62
+ "params": {
63
+ "accessor": "data",
64
+ "htmlContent": "<html>...</html>",
65
+ "format": "A4",
66
+ "printBackground": true
67
+ }
68
+ }
69
+ ```
70
+
71
+ #### Penjelasan
72
+
73
+ **Penyambung Kolam Tanpa Kepala** menguruskan kolam contoh pelayar tanpa kepala secara cekap untuk melaksanakan tugas seperti penjanaan PDF dan pengikisan web, memastikan pengoptimuman dan kebolehskalaan sumber dalam senario permintaan tinggi.
@@ -0,0 +1,71 @@
1
+ ### 无头浏览器池连接器 (Headless Pool Connector)
2
+
3
+ **无头浏览器池连接器**旨在管理无头浏览器实例的池。该连接器在执行需要多个无头浏览器会话同时运行的任务时非常有用,例如生成PDF或进行网页抓取。它能够有效地管理这些无头浏览器实例的创建、使用和销毁。
4
+
5
+ #### 端点
6
+
7
+ `无头浏览器池连接器`不要求特定的端点,但可以作为连接设置的一部分提供URI。此URI通常作为占位符使用,池在内部处理实际连接。也就是说,端点可以输入任意字符串。
8
+
9
+ #### 参数
10
+
11
+ - **min** (数字):
12
+ - 指定池中维持的最少无头浏览器实例数量。
13
+ - 默认值: `2`
14
+ - **max** (数字):
15
+ - 指定池中可以处理的最大无头浏览器实例数量。
16
+ - 默认值: `10`
17
+
18
+ 这些参数允许根据预期的工作负载调整池的大小。例如,如果应用程序经常同时需要多个浏览器实例,则可以增加`max`值。
19
+
20
+ #### 设置示例
21
+
22
+ ```json
23
+ {
24
+ "name": "headless-browser-pool",
25
+ "connector": "headless-connector",
26
+ "endpoint": "1",
27
+ "params": {
28
+ "min": 5,
29
+ "max": 20
30
+ }
31
+ }
32
+ ```
33
+
34
+ 在上述示例中,池至少保持5个无头浏览器实例,并且在需要时可以扩展到最多20个实例。
35
+
36
+ #### 连接生命周期
37
+
38
+ - **connect**:
39
+
40
+ - 初始化连接,根据设定的参数(`min` 和 `max`)创建无头浏览器实例池。
41
+ - 池会自动管理这些实例的生命周期,必要时创建新的实例并重用现有的实例。
42
+
43
+ - **disconnect**:
44
+ - 销毁无头浏览器池,确保所有实例都被适当关闭并释放资源。
45
+
46
+ #### 使用场景
47
+
48
+ `无头浏览器池连接器`主要用于需要在无头浏览器环境中执行任务的场景。例如,生成HTML内容的PDF、捕获网页截图或从网站抓取数据。
49
+
50
+ #### 支持的任务
51
+
52
+ `无头浏览器池连接器`支持以 `headless-pdf` 为前缀的任务。这些任务将使用由此连接器管理的无头浏览器实例。
53
+
54
+ #### 任务示例使用
55
+
56
+ ```json
57
+ {
58
+ "name": "generate-pdf",
59
+ "taskType": "headless-pdf-capture",
60
+ "params": {
61
+ "accessor": "data",
62
+ "htmlContent": "<html>...</html>",
63
+ "format": "A4",
64
+ "printBackground": true
65
+ }
66
+ }
67
+ ```
68
+
69
+ #### 说明
70
+
71
+ **无头浏览器池连接器**通过高效管理无头浏览器实例池,确保在高需求场景下执行PDF生成和网页抓取等任务时,资源利用的优化和可扩展性。
@@ -0,0 +1,51 @@
1
+ ### ヘッドレスPDFキャプチャボードタスク (Headless PDF Capture Board Task)
2
+
3
+ **ヘッドレスPDFキャプチャボードタスク**は、指定されたボード(例:ダッシュボードやレポート)をPDFとしてキャプチャし、PDFドキュメントに追加するタスクです。このタスクは、`headless-pdf-open`タスクで作成されたPDFドキュメントに、ボードの内容をレンダリングして新しいページを追加し、ヘッダー、フッター、ウォーターマークなどの設定を含めることができます。
4
+
5
+ #### パラメータ説明
6
+
7
+ - **accessor**: ボードデータを取得するためのパスを指定します。このパスは、データ構造からボードに関連する情報を抽出するために使用されます。
8
+
9
+ - **board**: キャプチャするボードを指定します。ボードの`id`を含むオブジェクトを渡す必要があり、この`id`を使用して指定されたボードがレンダリングされます。
10
+
11
+ - **draft**: `true`に設定すると、現在作業中のボードのバージョンを使用し、`false`に設定すると、最後にリリースされたボードのバージョンを使用します。デフォルト値は`false`です。
12
+
13
+ - **format**: PDFページのサイズを指定します。`A4`、`A3`、`Letter`、`Legal`などから選択できます。
14
+
15
+ - **width**: ページの幅を指定します。例: `"8.5in"`、`"21cm"`、`"600px"`。指定しない場合、`format`に従って自動的に設定されます。
16
+
17
+ - **height**: ページの高さを指定します。例: `"11in"`、`"29.7cm"`、`"800px"`。指定しない場合、`format`に従って自動的に設定されます。
18
+
19
+ - **marginTop**: ページの上部の余白を指定します。例: `"0.5in"`、`"1cm"`、`"100px"`。
20
+
21
+ - **marginBottom**: ページの下部の余白を指定します。例: `"0.5in"`、`"1cm"`、`"100px"`。
22
+
23
+ - **marginLeft**: ページの左側の余白を指定します。例: `"0.5in"`、`"1cm"`、`"100px"`。
24
+
25
+ - **marginRight**: ページの右側の余白を指定します。例: `"0.5in"`、`"1cm"`、`"100px"`。
26
+
27
+ - **scale**: ページコンテンツのスケールを調整します。デフォルト値は`1`で、値が大きいほどコンテンツが拡大されます。
28
+
29
+ - **printBackground**: `true`に設定すると、HTMLページの背景画像や色が含まれます。デフォルト値は`true`です。
30
+
31
+ - **landscape**: `true`に設定すると、PDFが横向きに生成されます。デフォルト値は`false`です。
32
+
33
+ - **preferCSSPageSize**: `true`に設定すると、CSSで定義されたページサイズが優先されます。デフォルト値は`false`です。
34
+
35
+ #### 主な機能
36
+
37
+ - **ボードのレンダリング**: 指定されたボードの内容をキャプチャしてPDFドキュメントに追加します。このタスクはボードの現在の状態をそのまま反映し、ボードのさまざまな視覚要素を含めることができます。
38
+
39
+ - **ヘッダーとフッターの設定**: 各ページに動的にヘッダーとフッターを挿入できます。ヘッダーとフッターはejsテンプレートで作成され、ページ番号や総ページ数などを動的に含めることができます。
40
+
41
+ - **ウォーターマークの設定**: PDFページにウォーターマークを追加できます。ウォーターマークはテキストとして表示され、通常はページの中央に半透明で配置されます。
42
+
43
+ - **ページ設定**: ページサイズ、余白、スケールなどを設定して、PDFドキュメントのレイアウトを調整できます。
44
+
45
+ #### 使用時の注意点
46
+
47
+ - **`HeadlessPDFOpen`タスクを事前に実行する必要がある**: `HeadlessPDFCaptureBoard`タスクは、必ず`HeadlessPDFOpen`タスクの後に実行する必要があります。そうでない場合、PDFドキュメントが存在しないため、エラーが発生します。
48
+
49
+ - **動的データ処理**: ejsテンプレートを使用してHTMLコンテンツを動的に生成でき、テンプレート内で`accessor`を使用してデータにアクセスできます。
50
+
51
+ - **ヘッダー/フッター**: `HeadlessPDFOpen`で設定されたヘッダーとフッターが自動的に含まれ、必要に応じて各ページごとに調整できます。
@@ -0,0 +1,51 @@
1
+ ### Headless PDF Capture Board Task
2
+
3
+ **Headless PDF Capture Board Task**는 주어진 보드(예: 대시보드 또는 보고서)를 PDF로 캡처하여 PDF 문서에 추가하는 작업입니다. 이 작업은 `headless-pdf-open` 작업으로 생성된 PDF 문서에 보드의 내용을 렌더링하여 새로운 페이지를 추가하며, 헤더, 푸터, 워터마크 등의 설정을 포함할 수 있습니다.
4
+
5
+ #### 매개변수 설명
6
+
7
+ - **accessor**: 보드 데이터를 가져오기 위한 경로를 지정합니다. 이 경로는 데이터 구조에서 보드와 관련된 정보를 추출하는 데 사용됩니다.
8
+
9
+ - **board**: 캡처할 보드를 지정합니다. 보드의 `id`를 포함하는 객체를 전달해야 하며, 이 `id`를 사용하여 지정된 보드가 렌더링됩니다.
10
+
11
+ - **draft**: `true`로 설정하면 현재 작업 중인 보드의 버전을, `false`로 설정하면 마지막으로 릴리즈된 보드의 버전을 사용합니다. 기본값은 `false`입니다.
12
+
13
+ - **format**: PDF 페이지의 크기를 지정합니다. `A4`, `A3`, `Letter`, `Legal` 등의 값 중에서 선택할 수 있습니다.
14
+
15
+ - **width**: 페이지의 폭을 지정합니다. 예: `"8.5in"`, `"21cm"`, `"600px"`. 지정하지 않으면 `format`에 따라 자동으로 설정됩니다.
16
+
17
+ - **height**: 페이지의 높이를 지정합니다. 예: `"11in"`, `"29.7cm"`, `"800px"`. 지정하지 않으면 `format`에 따라 자동으로 설정됩니다.
18
+
19
+ - **marginTop**: 페이지 상단 여백을 지정합니다. 예: `"0.5in"`, `"1cm"`, `"100px"`.
20
+
21
+ - **marginBottom**: 페이지 하단 여백을 지정합니다. 예: `"0.5in"`, `"1cm"`, `"100px"`.
22
+
23
+ - **marginLeft**: 페이지 왼쪽 여백을 지정합니다. 예: `"0.5in"`, `"1cm"`, `"100px"`.
24
+
25
+ - **marginRight**: 페이지 오른쪽 여백을 지정합니다. 예: `"0.5in"`, `"1cm"`, `"100px"`.
26
+
27
+ - **scale**: 페이지 콘텐츠의 스케일을 조정합니다. 기본값은 `1`이며, 값이 클수록 콘텐츠가 확대됩니다.
28
+
29
+ - **printBackground**: `true`로 설정하면, HTML 페이지의 배경 이미지나 색상이 포함됩니다. 기본값은 `true`입니다.
30
+
31
+ - **landscape**: `true`로 설정하면, PDF가 가로 방향으로 생성됩니다. 기본값은 `false`입니다.
32
+
33
+ - **preferCSSPageSize**: `true`로 설정하면, CSS에서 정의된 페이지 크기를 우선시하여 사용합니다. 기본값은 `false`입니다.
34
+
35
+ #### 주요 기능
36
+
37
+ - **보드 렌더링**: 지정된 보드의 내용을 캡처하여 PDF 문서에 추가합니다. 이 작업은 보드의 현재 상태를 그대로 반영하며, 보드의 다양한 시각적 요소를 포함할 수 있습니다.
38
+
39
+ - **헤더 및 푸터 설정**: 각 페이지에 동적으로 헤더와 푸터를 삽입할 수 있습니다. 헤더와 푸터는 ejs 템플릿으로 작성되며, 페이지 번호와 총 페이지 수 등을 동적으로 포함할 수 있습니다.
40
+
41
+ - **워터마크 설정**: PDF 페이지에 워터마크를 추가할 수 있습니다. 워터마크는 텍스트로 표시되며, 페이지의 중앙에 반투명으로 배치할 수 있습니다.
42
+
43
+ - **페이지 설정**: 페이지의 크기, 여백, 스케일 등을 설정하여 PDF 문서를 원하는 레이아웃으로 조정할 수 있습니다.
44
+
45
+ #### 사용 시 유의사항
46
+
47
+ - **이전에 `HeadlessPDFOpen` 작업이 실행되어야 함**: `HeadlessPDFCaptureBoard` 작업은 반드시 이전에 `HeadlessPDFOpen` 작업이 수행된 후에 실행되어야 합니다. 그렇지 않으면 PDF 문서가 존재하지 않기 때문에 오류가 발생합니다.
48
+
49
+ - **동적 데이터 처리**: ejs 템플릿을 통해 동적으로 HTML 콘텐츠를 생성할 수 있으며, 템플릿에서 `accessor`를 사용하여 데이터에 접근할 수 있습니다.
50
+
51
+ - **헤더/푸터**: `HeadlessPDFOpen`에서 설정된 헤더와 푸터가 자동으로 포함될 수 있으며, 필요에 따라 각 페이지에 맞게 조정할 수 있습니다.
@@ -0,0 +1,51 @@
1
+ ### Headless PDF Capture Board Task
2
+
3
+ **Headless PDF Capture Board Task** is a task that captures a given board (e.g., dashboard or report) as a PDF and adds it to a PDF document. This task renders the content of the board and adds new pages to the PDF document created by the `headless-pdf-open` task, and can include settings such as headers, footers, and watermarks.
4
+
5
+ #### Parameter Descriptions
6
+
7
+ - **accessor**: Specifies the path to retrieve board data. This path is used to extract information related to the board from the data structure.
8
+
9
+ - **board**: Specifies the board to be captured. An object containing the board's `id` must be provided, and this `id` is used to render the specified board.
10
+
11
+ - **draft**: When set to `true`, the version of the board currently being worked on is used; when set to `false`, the last released version of the board is used. The default value is `false`.
12
+
13
+ - **format**: Specifies the size of the PDF page. You can choose from `A4`, `A3`, `Letter`, `Legal`, etc.
14
+
15
+ - **width**: Specifies the width of the page, e.g., `"8.5in"`, `"21cm"`, `"600px"`. If not specified, it is automatically set according to the `format`.
16
+
17
+ - **height**: Specifies the height of the page, e.g., `"11in"`, `"29.7cm"`, `"800px"`. If not specified, it is automatically set according to the `format`.
18
+
19
+ - **marginTop**: Specifies the top margin of the page, e.g., `"0.5in"`, `"1cm"`, `"100px"`.
20
+
21
+ - **marginBottom**: Specifies the bottom margin of the page, e.g., `"0.5in"`, `"1cm"`, `"100px"`.
22
+
23
+ - **marginLeft**: Specifies the left margin of the page, e.g., `"0.5in"`, `"1cm"`, `"100px"`.
24
+
25
+ - **marginRight**: Specifies the right margin of the page, e.g., `"0.5in"`, `"1cm"`, `"100px"`.
26
+
27
+ - **scale**: Adjusts the scale of the page content. The default value is `1`, and the larger the value, the larger the content.
28
+
29
+ - **printBackground**: When set to `true`, background images or colors of the HTML page are included. The default value is `true`.
30
+
31
+ - **landscape**: When set to `true`, the PDF is generated in landscape orientation. The default value is `false`.
32
+
33
+ - **preferCSSPageSize**: When set to `true`, the page size defined in CSS is preferred. The default value is `false`.
34
+
35
+ #### Key Features
36
+
37
+ - **Board Rendering**: Captures the content of the specified board and adds it to the PDF document. This task reflects the current state of the board and can include various visual elements of the board.
38
+
39
+ - **Header and Footer Settings**: Dynamically insert headers and footers on each page. Headers and footers are written using ejs templates, which can dynamically include page numbers and total pages.
40
+
41
+ - **Watermark Settings**: Add a watermark to the PDF pages. The watermark is displayed as text, usually placed semi-transparently in the center of the page.
42
+
43
+ - **Page Settings**: Configure the page size, margins, scale, etc., to adjust the layout of the PDF document as desired.
44
+
45
+ #### Usage Notes
46
+
47
+ - **Must Execute `HeadlessPDFOpen` Task First**: The `HeadlessPDFCaptureBoard` task must be executed after the `HeadlessPDFOpen` task. Otherwise, an error will occur because the PDF document does not exist.
48
+
49
+ - **Dynamic Data Handling**: HTML content can be generated dynamically using ejs templates, and `accessor` can be used to access data within the template.
50
+
51
+ - **Headers/Footers**: The headers and footers set in `HeadlessPDFOpen` are automatically included and can be adjusted for each page if necessary.
@@ -0,0 +1,53 @@
1
+ ### Tugas Tangkap Papan PDF Tanpa Kepala (Headless PDF Capture Board
2
+
3
+ Task)
4
+
5
+ **Tugas Tangkap Papan PDF Tanpa Kepala** ialah tugas yang menangkap papan yang diberikan (seperti papan pemuka atau laporan) sebagai PDF dan menambahnya ke dalam dokumen PDF. Tugas ini merender kandungan papan dan menambah halaman baru ke dalam dokumen PDF yang dihasilkan oleh tugas `headless-pdf-open`, serta boleh menyertakan tetapan seperti header, footer, dan watermark.
6
+
7
+ #### Penerangan Parameter
8
+
9
+ - **accessor**: Menetapkan laluan untuk mendapatkan data papan. Laluan ini digunakan untuk mengekstrak maklumat berkaitan papan daripada struktur data.
10
+
11
+ - **board**: Menetapkan papan yang ingin ditangkap. Anda perlu memberikan objek yang mengandungi `id` papan, dan `id` ini akan digunakan untuk merender papan yang ditetapkan.
12
+
13
+ - **draft**: Apabila disetkan kepada `true`, versi papan yang sedang diusahakan akan digunakan; apabila disetkan kepada `false`, versi papan terakhir yang dikeluarkan akan digunakan. Nilai lalai ialah `false`.
14
+
15
+ - **format**: Menetapkan saiz halaman PDF. Anda boleh memilih antara `A4`, `A3`, `Letter`, `Legal`, dan lain-lain.
16
+
17
+ - **width**: Menetapkan lebar halaman. Contoh: `"8.5in"`, `"21cm"`, `"600px"`. Jika tidak ditetapkan, ia akan diselaraskan secara automatik berdasarkan `format`.
18
+
19
+ - **height**: Menetapkan ketinggian halaman. Contoh: `"11in"`, `"29.7cm"`, `"800px"`. Jika tidak ditetapkan, ia akan diselaraskan secara automatik berdasarkan `format`.
20
+
21
+ - **marginTop**: Menetapkan margin atas halaman. Contoh: `"0.5in"`, `"1cm"`, `"100px"`.
22
+
23
+ - **marginBottom**: Menetapkan margin bawah halaman. Contoh: `"0.5in"`, `"1cm"`, `"100px"`.
24
+
25
+ - **marginLeft**: Menetapkan margin kiri halaman. Contoh: `"0.5in"`, `"1cm"`, `"100px"`.
26
+
27
+ - **marginRight**: Menetapkan margin kanan halaman. Contoh: `"0.5in"`, `"1cm"`, `"100px"`.
28
+
29
+ - **scale**: Menyesuaikan skala kandungan halaman. Nilai lalai ialah `1`, dan semakin besar nilainya, semakin besar kandungan.
30
+
31
+ - **printBackground**: Apabila disetkan kepada `true`, imej latar belakang atau warna halaman HTML akan disertakan. Nilai lalai ialah `true`.
32
+
33
+ - **landscape**: Apabila disetkan kepada `true`, PDF akan dijana dalam orientasi landskap. Nilai lalai ialah `false`.
34
+
35
+ - **preferCSSPageSize**: Apabila disetkan kepada `true`, saiz halaman yang ditentukan dalam CSS akan diutamakan. Nilai lalai ialah `false`.
36
+
37
+ #### Fungsi Utama
38
+
39
+ - **Merender Papan**: Menangkap kandungan papan yang ditetapkan dan menambahnya ke dalam dokumen PDF. Tugas ini akan mencerminkan keadaan semasa papan dan boleh menyertakan pelbagai elemen visual papan.
40
+
41
+ - **Tetapan Header dan Footer**: Boleh memasukkan header dan footer secara dinamik pada setiap halaman. Header dan footer ditulis menggunakan templat ejs, yang boleh memasukkan nombor halaman dan jumlah halaman secara dinamik.
42
+
43
+ - **Tetapan Watermark**: Boleh menambah watermark pada halaman PDF. Watermark dipaparkan sebagai teks, dan biasanya diletakkan secara lut sinar di tengah halaman.
44
+
45
+ - **Tetapan Halaman**: Boleh melaraskan saiz halaman, margin, skala, dan lain-lain untuk menyusun dokumen PDF mengikut keinginan anda.
46
+
47
+ #### Perhatian Semasa Penggunaan
48
+
49
+ - **Tugas `HeadlessPDFOpen` perlu dijalankan terlebih dahulu**: Tugas `HeadlessPDFCaptureBoard` mesti dijalankan selepas tugas `HeadlessPDFOpen`. Jika tidak, dokumen PDF tidak wujud, dan ralat akan berlaku.
50
+
51
+ - **Pemprosesan Data Dinamik**: Kandungan HTML boleh dijana secara dinamik menggunakan templat ejs, dan `accessor` boleh digunakan untuk mengakses data dalam templat.
52
+
53
+ - **Header/Footer**: Header dan footer yang ditetapkan dalam `HeadlessPDFOpen` akan disertakan secara automatik, dan boleh disesuaikan mengikut setiap halaman jika perlu.
@@ -0,0 +1,51 @@
1
+ ### 无头PDF捕捉板任务 (Headless PDF Capture Board Task)
2
+
3
+ **无头PDF捕捉板任务**是将给定的板(如仪表板或报告)捕捉为PDF并添加到PDF文档中的任务。此任务通过渲染板的内容,向由`headless-pdf-open`任务创建的PDF文档中添加新页面,并可以包括页眉、页脚、水印等设置。
4
+
5
+ #### 参数说明
6
+
7
+ - **accessor**: 指定用于获取板数据的路径。此路径用于从数据结构中提取与板相关的信息。
8
+
9
+ - **board**: 指定要捕捉的板。需要传递包含板的`id`的对象,并使用该`id`渲染指定的板。
10
+
11
+ - **draft**: 如果设置为`true`,则使用当前正在处理的板版本;如果设置为`false`,则使用最后发布的板版本。默认值为`false`。
12
+
13
+ - **format**: 指定PDF页面的大小。可以选择`A4`、`A3`、`Letter`、`Legal`等值。
14
+
15
+ - **width**: 指定页面的宽度。例如:`"8.5in"`、`"21cm"`、`"600px"`。如果未指定,将根据`format`自动设置。
16
+
17
+ - **height**: 指定页面的高度。例如:`"11in"`、`"29.7cm"`、`"800px"`。如果未指定,将根据`format`自动设置。
18
+
19
+ - **marginTop**: 指定页面的上边距。例如:`"0.5in"`、`"1cm"`、`"100px"`。
20
+
21
+ - **marginBottom**: 指定页面的下边距。例如:`"0.5in"`、`"1cm"`、`"100px"`。
22
+
23
+ - **marginLeft**: 指定页面的左边距。例如:`"0.5in"`、`"1cm"`、`"100px"`。
24
+
25
+ - **marginRight**: 指定页面的右边距。例如:`"0.5in"`、`"1cm"`、`"100px"`。
26
+
27
+ - **scale**: 调整页面内容的缩放比例。默认值为`1`,值越大,内容越大。
28
+
29
+ - **printBackground**: 如果设置为`true`,将包含HTML页面的背景图像或颜色。默认值为`true`。
30
+
31
+ - **landscape**: 如果设置为`true`,PDF将以横向生成。默认值为`false`。
32
+
33
+ - **preferCSSPageSize**: 如果设置为`true`,优先使用CSS中定义的页面大小。默认值为`false`。
34
+
35
+ #### 主要功能
36
+
37
+ - **板渲染**: 捕捉指定板的内容并将其添加到PDF文档中。此任务会准确反映板的当前状态,并可包含板的各种视觉元素。
38
+
39
+ - **页眉和页脚设置**: 可以动态插入每页的页眉和页脚。页眉和页脚使用ejs模板编写,可以动态包含页码和总页数等信息。
40
+
41
+ - **水印设置**: 可以为PDF页面添加水印。水印以文本形式显示,通常半透明地放置在页面中央。
42
+
43
+ - **页面设置**: 可以通过设置页面的大小、边距、缩放等来调整PDF文档的布局。
44
+
45
+ #### 使用注意事项
46
+
47
+ - **必须先执行`HeadlessPDFOpen`任务**: `HeadlessPDFCaptureBoard`任务必须在`HeadlessPDFOpen`任务之后执行,否则会因为PDF文档不存在而导致错误。
48
+
49
+ - **动态数据处理**: 可以通过ejs模板动态生成HTML内容,并使用`accessor`从数据中获取信息。
50
+
51
+ - **页眉/页脚**: `HeadlessPDFOpen`中设置的页眉和页脚将自动包含,必要时可以针对每个页面进行调整。