在 Twenty 中生成 PDF

创建一个工作流，用于生成 PDF（例如报价单）并将其附加到记录。

自动生成或获取 PDF，并将其附加到 Twenty 中的记录。 这通常用于创建与公司、商机或其他对象关联的报价单、发票或报告。

​

概览

此工作流使用 手动触发器，因此用户可以按需为任何选定的记录生成 PDF。 逻辑函数 句柄：

1. 从 URL（来自 PDF 生成服务）下载 PDF
2. 将文件上传到 Twenty
3. 创建与该记录关联的附件

​

先决条件

设置工作流之前：

1. 创建 API 密钥：前往 设置 → APIs 并创建一个新的 API 密钥。 逻辑函数需要这个令牌。
2. 设置 PDF 生成服务（可选）：如果您想动态生成 PDF（例如报价单），可使用 Carbone、PDFMonkey 或 DocuSeal 等服务来创建 PDF 并获取下载 URL。

​

分步设置

​

步骤 1：配置触发器

1. 转到 工作流 并创建一个新工作流
2. 选择 手动触发器
3. 选择要将 PDF 附加到的对象（例如，公司 或 商机）

手动触发， 用户可以使用右上角显示的按钮来运行此工作流——这将运行工作流来生成并附加一个 PDF

​

步骤 2: 添加逻辑函数

1. 添加 代码 动作(逻辑函数)
2. 使用下面的代码创建一个新函数
3. 配置输入参数

​

输入参数

参数	值
companyId	{{trigger.object.id}}

如果附加到一个不同的对象(人员、机会等)，则相应重命名参数(如：personId、opportunityId)，并更新逻辑函数。

​

逻辑函数代码

export const main = async (
  params: { companyId: string },
) => {
  const { companyId } = params;
  // Replace with your Twenty GraphQL endpoints (/metadata for metadata and files or /graphql for your records)
  // Cloud: https://api.twenty.com/graphql
  // Self-hosted: https://your-domain.com/graphql

  const metadataGraphqlEndpoint = 'https://api.twenty.com/metadata';
  const dataGraphqlEndpoint = 'https://api.twenty.com/graphql';

  // Replace with your API key from Settings → APIs
  const authToken = 'YOUR_API_KEY';

  // Replace with your PDF URL
  // This could be from a PDF generation service or a static URL
  const pdfUrl = 'https://your-pdf-service.com/generated-quote.pdf';
  const filename = 'quote.pdf';

  // Step 1: Download the PDF file
  const pdfResponse = await fetch(pdfUrl);

  if (!pdfResponse.ok) {
    throw new Error(`Failed to download PDF: ${pdfResponse.status}`);
  }

  const pdfBlob = await pdfResponse.blob();
  const pdfFile = new File([pdfBlob], filename, { type: 'application/pdf' });

  const fieldMetadataIdQuery = `
    query FindUploadFileFieldMetadataId {
      objects {
        edges {
          node {
            nameSingular
            fieldsList {
              id
              name
            }
          }
        }
      }
    }
  `;

  // Step 2: Find a fieldMetadataId of "Attachment file" field in Attachments object with GraphQL API
  const response = await fetch(metadataGraphqlEndpoint, {
      method: 'POST',
      headers: {
        Authorization: `Bearer ${authToken}`
      },
      body: {
        query: fieldMetadataIdQuery,
      }
    });
  const result = await response.json();
  const uploadFileFieldMetadataId = result.data.objects.edges.find(object => object.node.nameSingular === 'attachment').node.fieldsList.find(field => field.name === 'file').id;

  // Step 3: Upload the file via GraphQL multipart upload
  const uploadMutation = `
    mutation UploadFilesFieldFile($file: Upload!, $fieldMetadataId: String!) {
      uploadFilesFieldFile(file: $file, fieldMetadataId: $fieldMetadataId) {
        id
      }
    }
  `;

  const uploadForm = new FormData();
  uploadForm.append('operations', JSON.stringify({
    query: uploadMutation,
    variables: { file: null, fieldMetadataId: uploadFileFieldMetadataId },
  }));
  uploadForm.append('map', JSON.stringify({ '0': ['variables.file'] }));
  uploadForm.append('0', pdfFile);

  const uploadResponse = await fetch(metadataGraphqlEndpoint, {
    method: 'POST',
    headers: { Authorization: `Bearer ${authToken}` },
    body: uploadForm,
  });

  const uploadResult = await uploadResponse.json();

  if (uploadResult.errors?.length) {
    throw new Error(`Upload failed: ${uploadResult.errors[0].message}`);
  }

  const fileId = uploadResult.data?.uploadFilesFieldFile?.id;

  if (!fileId) {
    throw new Error('No file id returned from upload');
  }

  // Step 4: Create the attachment linked to the company
  const attachmentMutation = `
    mutation CreateOneAttachment($data: AttachmentCreateInput!) {
      createAttachment(data: $data) {
        id
        name
      }
    }
  `;

  const attachmentResponse = await fetch(dataGraphqlEndpoint, {
    method: 'POST',
    headers: {
      Authorization: `Bearer ${authToken}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      query: attachmentMutation,
      variables: {
        data: {
          name: filename,
          targetCompanyId: companyId,
          file: [
            {
              fileId: fileId,
              label: filename
            }
          ]
        },
      },
    }),
  });

  const attachmentResult = await attachmentResponse.json();

  if (attachmentResult.errors?.length) {
    throw new Error(`Attachment creation failed: ${attachmentResult.errors[0].message}`);
  }

  return attachmentResult.data?.createAttachment;
};

​

步骤 3：根据您的用例自定义

​

要附加到其他对象

将 targetCompanyId 替换为相应的字段：

对象	字段名称
公司	targetCompanyId
人员	targetPersonId
机会	targetOpportunityId
自定义对象	targetYourCustomObjectId

同时更新函数参数以及附件的 mutation 中的 variables.data 对象。

​

要使用动态 PDF URL

如果使用 PDF 生成服务，您可以：

1. 首先创建一个 HTTP 请求操作以生成 PDF
2. 将返回的 PDF URL 传递到逻辑函数作为参数

export const main = async (
  params: { companyId: string; pdfUrl: string; filename: string },
) => {
  const { companyId, pdfUrl, filename } = params;
  // ... rest of the function
};

​

步骤 4：测试并启用

1. 保存工作流
2. 导航到一条公司记录
3. 单击 ⋮ 菜单并选择您的工作流
4. 在记录上的 附件 部分检查并确认 PDF 已被附加
5. 激活工作流

​

与 PDF 生成服务结合使用

用于创建动态报价单或发票：

​

示例：生成报价单 → 附加 PDF

步骤	操作	目的
1	手动触发器（公司）	用户在记录上发起
2	搜索记录	获取商机或行项目详情
3	HTTP请求	使用记录数据调用 PDF 生成 API
4	逻辑函数	下载并附加生成的 PDF

​

常用的 PDF 生成服务

• Carbone - 基于模板的文档生成
• PDFMonkey - 基于模板的动态 PDF 创建
• DocuSeal - 文档自动化平台
• Documint - API 优先的文档生成

每个服务提供一个 API 返回一个 PDF URL，然后你可以传递到逻辑函数。

​

故障排除

问题	解决方案
”无法下载 PDF”	检查 PDF URL 是否可访问并返回有效的 PDF
”上传失败”	验证您的 API 密钥有效且具有写入权限
”附件创建失败”	确保对象 ID 字段名称与您的目标对象匹配

​

相关内容

• 工作流触发器
• 逻辑函数
• 从 Twenty 生成报价单或发票