Salesforce × ApexでPDFを出力する方法｜コード付き

※本サイトにはプロモーション・広告が含まれています。

✔以下の疑問をお持ちの方へ向けた記事です

「SalesforceのApexでPDF文書をどのように生成するのか？」
「Apexを用いたPDF生成の基本的なプロセスは？」
「ApexでPDFを生成する際の具体的なコーディング例を見てみたい」

✔当記事を読むことで得られる知識

  • Salesforce ApexでPDF文書を生成する方法
  • Visualforceページを使用したPDF生成のプロセス
  • ApexでPDFを生成するための具体的なコード例

当記事では、Salesforceの開発プラットフォームであるApexを使用してPDF文書を生成する方法について詳しく見ていきましょう。

Visualforceページを用いてPDFのレイアウトを定義し、ApexコードでそれをPDFとして出力するプロセスに焦点を当てます。

Salesforce開発者やApexの学習者にとって、役立つ情報が満載です。

ぜひ最後までご覧ください。

Salesforce

定義や属性などは公式ガイドを必ず参考にしましょう。

当記事では、主にその使い方を具体例とともに解説します。

筆者プロフィール

筆者プロフィールアイコン

【現職】プロダクトマネージャー

プロダクトマネージャーとして、Apex・Visualforceの開発エンジニアとして、以下のようなプロジェクトに従事してきました

  • 新規事業の立ち上げに伴うビジネスプロセス構築とSalesforceのカスタマイズ
  • SFDXを活用した大規模リリース
  • Visualforce等による一般ユーザー向けサイト・アプリケーションの構築

相談・業務の依頼も承ります。ご質問・ご希望をお問い合わせください。

ApexとPDFの基本

こちらでは、ApexでPDFを生成する基本知識について解説します。

セールスフォースプラットフォーム上で、レポートや請求書を効果的に配布するためにはPDFの活用が不可欠で、ここでの理解がさまざまなビジネスシーンに役立つでしょう。

  • ApexでのPDF生成とは何か
  • SalesforceにおけるPDFの役割と利点
  • PDF生成に関連するApexクラスの概要

ApexでのPDF生成とは何か

Apexを使用して、Salesforce上で文書をフォーマットし、配布用のファイル（PDF）の作成が可能です。

以下の要素でPDF出力が可能になります。

  • PageReference クラスを定義
  • Visualforceページを参照
  • getContentAsPDF() メソッドを呼び出す

そのページをPDFとして出力できます。

以下はその基本的なコードスニペットです。

PageReference myPage = Page.MyVisualforcePage;
Blob pdfBlob = myPage.getContentAsPDF();

この方法で生成されたPDFは、外部のクライアントや内部のチームメンバーに報告書や契約書として送信するために利用できます。

SalesforceにおけるPDFの役割と利点

Salesforceの環境内でPDF形式を使用する利点は多岐に渡ります。

  • 書式やレイアウトが崩れにくく、一貫した情報伝達を保証できる
  • パスワード保護やデジタル署名などのセキュリティ機能を備え、機密情報を安全に扱える
  • Salesforceレコードから動的に情報を反映し、カスタマイズされたコミュニケーションが可能

PDF生成に関連するApexクラスの概要

ApexでPDFを生成する際には、主にPageReference クラスとBlob クラスが使用されます。

PageReference クラスは、Visualforceページへの参照を表し、getContentAsPDF() メソッドを介してページの内容をPDFとして取得できます。

Blob クラスは、バイナリデータのハンドリングをおこなうためのクラスで、生成されたPDFの内容をバイナリ形式で保持するものです。

これらのクラスを適切に使用することで、さまざまなPDF文書を動的に生成し、業務フローに組み込めます。

PDF生成の基本手順

次に、Salesforce上でPDFを生成する基本的な手順を紹介します。

正確なPDFをスムーズに作成するためには、以下に示す工程を理解し、適切な順序で実行することが重要です。

  • Visualforceページの作成
  • ApexコントローラでのPDF生成処理
  • PDFファイルのカスタマイズとデザイン

Visualforceページの作成

VisualforceページはSalesforceのカスタマイズ可能なユーザーインタフェースを提供し、PDFのためのテンプレートとして機能します。

以下はシンプルなVisualforceページの例です。

<apex:page renderAs="pdf">
    <h1>This is a PDF</h1>
    <p>This section will be rendered as part of the PDF file.</p>
</apex:page>

renderAs=""pdf"" 属性をページタグに加えると、このページがPDFとしてレンダリングされます。

内容のカスタマイゼーションにはHTMLやCSSが使用でき、動的なデータをVisualforceの標準コンポーネントやカスタムコンポーネントを用いて埋め込めます。

ただし日本語を表示したい場合、font-familyなどを適切に設定しなければいけません。

以下のテンプレートを参考に、日本語も表示できるようにしましょう。

使用可能なフォントについてはこちら（公式サイト）を参考にしてください。

<apex:page renderAs="pdf" showHeader="false" applyHtmlTag="false" sidebar="false" standardStylesheets="false" cache="false" >
    <head>
        <style>
            * { font-family: Arial Unicode MS;}
        </style>
    </head>
    <div>
        <p>これはVisualforceで生成したPDFです。</p>
    </div>
</apex:page>

ApexコントローラでのPDF生成処理

PDF生成のコントロールはApexコントローラクラスでおこなわれます。

生成するPDFに必要なデータを操作し、Visualforceページにバインドするためのメソッドを記述しましょう。

以下にApexコードの例を示します。

public with sharing class MyPDFController {
    public void generatePDF() {
        PageReference pdfPage = Page.MyVisualforcePage;
        Blob pdfContent = pdfPage.getContentAsPDF();
        // 以下にPDFを保存するためのコードを追加可能
    }
}

このコードは、指定したVisualforceページをPDFとして出力し、その内容をBlob オブジェクトに格納します。

後続の処理で、このBlob オブジェクトから実際のファイルを生成し、データベースに保存したり、メールで送信したりが可能です。

PDFファイルのカスタマイズとデザイン

PDFの見た目はビジネスにおいて非常に重要で、ブランディングやパーソナライズのためのカスタマイズが必要です。

PDFのデザインにはCSSを用いてスタイルを追加し、Visualforceページ内でクラスやIDを使用してページの各部分に適用できます。

PDF出力の際、Pタグ内の文字列などはそのまま出力されるため、画面がはみ出てしまうことがあります。

文字数などを確認のうえ、ただしく表示されることを確認しましょう。

フォントやカラー、レイアウトなど、細部にわたって調整することで、プロフェッショナルな文書を作成できます。

また、画像や会社のロゴ、ヘッダーやフッターなどの要素も適宜組み込むことで、企業アイデンティティを反映した文書を作成できます。

実践的なPDF生成の応用例

PDFの生成は、単に文書化するだけではなく、ビジネス上のさまざまな要求に応じて応用することが可能です。

具体的な応用例を以下で紹介します。

  • レポートと請求書のPDF化
  • ダイナミックなデータの統合
  • PDF生成の自動化と統合

レポートと請求書のPDF化

Salesforceは膨大な量のデータを処理し、それをレポートや請求書としてまとめることが可能です。

ApexとVisualforceを用いて、これらの文書をPDFとして効率的に出力できます。

たとえば、以下のコードはSalesforce内のレコードデータを取得してレポートのPDFを生成します。

public with sharing class ReportPDFController {
    public PageReference generateReportPDF() {
        // レコードデータを取得
        List<Opportunity> opportunities = [SELECT Id, Name, CloseDate FROM Opportunity];
        // その他転送したいデータがあればここに追加

        PageReference reportPage = Page.ReportTemplate;
        reportPage.setRedirect(false);
        reportPage.getParameters().put('id', 'some-id'); // 必要に応じてパラメータをセット
        Blob reportPDF = reportPage.getContentAsPDF();

        // PDFファイルを保存する処理を追加
        // ...
        return reportPage; // PDFをユーザーに直接表示するためにPageReferenceを返す
    }
}

Opportunity レコードのリストを取得し、それをテンプレートとして指定されているReportTemplate Visualforceページに組み込んでPDFを生成します。

このPDFはメール添付などで顧客に直接送信することができるため、手間を省きつつ速やかなコミュニケーションが可能です。

ダイナミックなデータの統合

Salesforce上で動的に変化するデータをPDF文書に反映させることは、ユーザーにとって最新の情報を提供する上で非常に重要です。

以下のコードスニペットは、Visualforceページ内でApexコントローラから渡されたデータを動的に表示し、その情報をPDFに統合する方法を示しています。

<apex:page controller="MyCustomController" renderAs="pdf">
    <h1>Monthly Sales Report</h1>
    <apex:repeat value=""{!salesData}"" var="data">
        <p>Product: {!data.productName}, Sales: {!data.salesAmount}</p>
    </apex:repeat>
</apex:page>

ApexコントローラであるMyCustomControllerに定義されたsalesDataコレクションをページにバインドしています。

apex:repeatタグを使用して、各販売データをリストとして表示。

このような動的なデータの統合は、毎月の売上報告や在庫状況の報告などに役立ちます。

PDF生成の自動化と統合

Salesforceのプロセス自動化機能を使用することで、PDFの生成を自動化し、企業運営の効率化を図れます。

例えば、Apexトリガーやフローを用いて、あるイベントが発生したときに自動的にPDFを生成し、関係者に配布するような設定が可能です。

次のApexトリガーの例は、新しい取引が確定した時に契約書のPDFを生成して保存する機能を持っています。

trigger ContractPDFTrigger on Opportunity (after insert) {
    for (Opportunity opp : Trigger.new) {
        if (opp.StageName == 'Closed Won') {
            PageReference contractPage = Page.ContractTemplate;
            contractPage.getParameters().put('id', opp.Id);
            Blob contractPDF = contractPage.getContentAsPDF();

            // このPDFをAttachmentsやContentVersionに保存
            // ...
        }
    }
}

after insertイベントでトリガーされるこのコードは、取引の状態がClosed Wonになると契約書のPDFを生成し、それをデータベースに保存する処理をおこなっています。

このように設定すると、人の手を介さずとも重要文書が適切なタイミングで生成・保存されるため、業務の自動化に大きく貢献します。

PDF生成のトラブルシューティング

こちらではPDF生成時の一般的な問題とその解決策に焦点を当てます。

PDFの生成においては、時に予期せぬ問題や課題に遭遇することがあるからです。

  • 一般的なPDF生成関連のエラー
  • レンダリングの問題と解決策
  • パフォーマンスとセキュリティの考慮事項

一般的なPDF生成関連のエラー

PDFを生成する過程で発生する可能性のある共通のエラーには、以下のようなものがあります。

  • 「フォントが見つからない」
  • 「画像が表示されない」
  • 「ページが正しくレンダリングされない」

これらの問題は、主にVisualforceページやApexコード内の設定間違いに起因するため、レンダリングに関する属性のチェックや、コードのデバッグが一般的な解決策です。

例えば、Visualforceページでフルパスで指定されていない画像のURLを修正することで、画像が表示されない問題を解決できることがあります。

<apex:image url=""{!$Resource.YourImage}"" width=""200"" height=""200""/>

上記の$Resource.YourImageは、Salesforceの静的リソースで登録した画像ファイルの名前を参照しています。

この方法で静的リソースを正しく指定することで、画像がPDFに正確にレンダリングされるようになります。

レンダリングの問題と解決策

PDFレンダリング時には、ページのサイズや配置が意図しない形で表示されることがあります。

これは主にCSSのスタイル設定やボックスモデルの不一致によるものです。

このような場合には、CSSの@pageルールを調整することで改善できます。

@page {
    size: A4;
    margin: 1cm;
}

こちらのCSSルールは、PDFページのサイズをA4サイズに設定し、各辺に1cmの余白をもたせることでページ全体のバランスを整えます。

このような細かなCSS設定の調整により、プロフェッショナルな外観のPDFを生成することが可能です。

パフォーマンスとセキュリティの考慮事項

PDFの生成に際しては、ページの処理速度とセキュリティも重要な要素。

大量のデータや複雑なレンダリングが必要な場合、パフォーマンスの低下が見られます。

無駄なリソースの読み込みを避けたり、非同期処理を利用したりすることで改善が期待できるでしょう。

また、PDFにはセキュリティ上のリスクが伴う可能性があるため、適切なアクセス権限を設定し、機密情報の扱いには特に注意が必要です。

Apexコード内でwith sharingやwithout sharingキーワードを適切に使用することで、アクセスコントロールが強化できます。

SalesforceのApexクラスでwith sharingを使う意味
SalesforceのApexで「With Sharing」キーワードを使用する方法とその重要性について学びたいですか？「With Sharing」キーワードは、セキュリティとデータアクセスの制御に重要な役割を果たし、レコードの可視性とユーザー権限を適切に管理するために使用されます。
itc.tokyo
2023.12.23

PDF生成のベストプラクティスと進化

ビジネスにおけるPDFの適用範囲は広く、その生成や管理には最適な手法の学習が欠かせません。

こちらでは、PDF生成の際に役立つベストプラクティスについてアドバイスを提供し、Salesforceの更新に伴うPDF機能の進化にも触れていきます。

  • デザインとユーザビリティのヒント
  • Salesforceの更新とPDF機能の進化
  • コミュニティとリソース

デザインとユーザビリティのヒント

PDFのデザインにおいては、読み手に快適でわかりやすい構成を心がけることが大切です。

良いPDFはただ情報を提示するだけでなく、視覚的にもアプローチしやすくなっています。

以下は、PDFのデザインにおけるヒントです。

  1. クリアなフォント選択
    読みやすいフォントを使用し、必要に応じてフォントサイズを調整します。
  2. 目次の活用
    長い文書の場合は、ハイパーリンク付きの目次を用いてナビゲーションを容易にします。
  3. マージンとスペーシング
    適切な余白と行間を設定することで、テキストの読みやすさを改善します。

このような詳細に気を配ることで、受け手にとって価値あるコンテンツを作成することができます。

Salesforceの更新とPDF機能の進化

Salesforceは定期的にシステムをアップデートし、さまざまな新機能が追加されるため、PDF生成機能に関しても進化しています。

例えば、Lightning ExperienceではLightningコンポーネントを使用したPDF生成が可能になり、よりモダンでリッチな文書を作成できるようになりました。

把握しきれない新機能が導入されることもあるため、リリースノートを定期的にチェックし、最新のベストプラクティスを学ぶことが重要です。

コミュニティとリソース

Salesforceのデベロッパーコミュニティは熱心で、多くの専門知識や経験が共有されています。

実際の問題解決や技術的な知識を得るために、Salesforce Developer ForumsやTrailheadなどのリソースを活用することが推奨されます。

また、GitHubなどのプラットフォームには多くの共有コードがあるため、自分のプロジェクトに適用できる例やプラグインを見つけられるでしょう。

まとめ

当記事では、初心者でも理解しやすいよう、具体的なコードやデザインのヒントを示しながら、最適なPDF生成法を解説してきました。

PDFはビジネスコミュニケーションにおいて便利なツールであり、今後もSalesforceのアップデートに合わせた機能の進化が期待されます。

最新の情報を追いかけながら、効率的かつプロフェッショナルなPDF文書を作成する技術を磨きましょう。

タイトルとURLをコピーしました