SalesforceのApexで添付ファイルを挿入する方法

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

（最終更新月: 2024年2月）

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

「Salesforce Apexでレコードに添付ファイルを挿入するにはどうすればよいか？」
「Apexを使用して添付ファイルを操作する際のステップは何か？」
「Apexで添付ファイルを扱う際のベストプラクティスは？」

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

  • Salesforce Apexでの添付ファイル挿入の基本的なプロセス
  • Blobデータ型を使用してファイルコンテンツを操作する方法
  • 添付ファイルの挿入に関するセキュリティとパフォーマンスの考慮事項

当記事では、Salesforceの開発プラットフォームであるApexを使用して、特定のレコードに添付ファイルを挿入する方法について詳しく解説します。

ファイルの挿入は、顧客情報、プロジェクトのドキュメント、製品画像など、多岐にわたるビジネスケースで必要とされる一般的な要件。

当記事がSalesforceの開発者にとって、アプリケーションの機能を拡張し、ユーザーの要求に応えるための貴重な情報源となるでしょう。

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

Salesforce

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

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

筆者プロフィール

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

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

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

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

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

Salesforce Apexにおける添付ファイルの扱い

SalesforceのApexにおける添付ファイルの扱いに焦点を当てて解説していきます。

添付ファイルを扱うことで、データベースにファイルを保存したり、特定のレコードに紐付けることが可能です。

  • 添付ファイルとは何か
  • 添付ファイルの利用シナリオ
  • Salesforceの添付ファイル関連オブジェクト

添付ファイルとは何か

Salesforceでいう添付ファイルとは、レコードに関連付けられた任意のファイルのこと。

これは文書、画像、PDFなど、多様な形式のファイルを含みます。

たとえば、Attachment オブジェクトを利用し、以下のようにApex内でファイルの添付が可能です。

Attachment att = new Attachment(ParentId = '001xxxxxxxxxxxx', Name = 'TestFile.txt');
att.Body = Blob.valueOf('Test file content');
insert att;

上記コードは、ParentIdで指定したレコードにテキストファイルを添付する簡単な例です。

このようにApexコードを使用することでファイルを操作できることを理解することが、Salesforceでのデータ管理において極めて重要です。

添付ファイルの利用シナリオ

添付ファイルの利用シナリオは多岐に渡ります。

  • 営業代表が顧客から受け取った契約書をリードやアカウントレコードに添付する
  • 顧客サービスチームがケースレコードに関連するスクリーンショットをアップロードする

また、カスタムアプリケーション開発時に特定のデータ型を格納するためにも利用されます。

これらのシナリオでは、適切なファイル管理が重要です。

Salesforceの添付ファイル関連オブジェクト

Salesforceには、いくつかの添付ファイル関連オブジェクトがあります。

  • 伝統的なAttachmentオブジェクト
  • Salesforce CRM ContentやChatterでより広く使われるContentDocument
  • バージョンの管理が可能なContentVersion

それぞれのオブジェクトを適切に使い分けることが求められます。

Apexでの添付ファイル挿入方法

Apexを使用して、Salesforceに添付ファイルを挿入する方法を検討します。

具体的な方法を知り、自身にあう適切な方法を試してください。

  • Attachment オブジェクトの作成
  • ファイルデータの準備と挿入
  • ContentVersionとContentDocumentを使用したモダンなアプローチ

Attachment オブジェクトの作成

AttachmentオブジェクトはSalesforceにおける基本的な添付ファイルのオブジェクトです。

以下のようなApexコードで、新しいAttachmentレコードの作成が可能です。

Attachment att = new Attachment();
att.ParentId = '001xxxxxxxxxxxx'; // 添付するレコードのID
att.Name = 'example.pdf';
att.Body = Blob.toPDF('Here is some text!');
insert att;

この例では、PDFファイルを作成し、指定されたParentIdのレコードに添付しています。

ファイルの内容はBlob.toPDFメソッドを使って文字列からPDFに変換されます。

ファイルデータの準備と挿入

ファイルデータの準備は、ファイルをApexコードで添付する前に実行する重要なステップです。

  1. データをBlob形式に変換
  2. AttachmentオブジェクトのBodyフィールドに格納する

以下は画像ファイルを添付する例です。

Attachment att = new Attachment();
att.ParentId = '003xxxxxxxxxxxx'; // 添付するレコードのID
att.Name = 'image.png';
att.ContentType = 'image/png';
att.Body = Blob.valueOf('Base64 encoded image data');
insert att;

まず、画像データをBase64形式の文字列にエンコードし、それをBlob.valueOfメソッドを利用してBlobデータに変換します。

ここではContentTypeも適切な設定が必要です。

ContentVersionとContentDocumentを使用したモダンなアプローチ

最近のSalesforce開発では、AttachmentオブジェクトよりもContentVersionやContentDocumentが推奨されます。

なぜなら新しいライブラリ管理機能に適合しており、より複雑なファイル管理要件を満たせるからです。

例えば、以下のようにContentVersionを使用して新しいファイルを挿入できます。

ContentVersion cv = new ContentVersion();
cv.Title = 'My Document';
cv.PathOnClient = 'MyDocument.docx';
cv.VersionData = Blob.valueOf('My Word file content');
cv.FirstPublishLocationId = 'a0Nxxxxxxxxxxxx'; // ライブラリなどのID
insert cv;

このコードでは、ContentVersionオブジェクトを生成。

VersionDataにファイルのデータがBlobとして格納され、特定の場所（例えば、Salesforceライブラリ）に公開されるためのFirstPublishLocationIdが指定されます。

添付ファイル操作の実践的応用

こちらでは、添付ファイル操作の応用方法を見ていきましょう。

Apexを使用して、Salesforce内の添付ファイルを操作する方法はいくつかあります。

  • プログラムによる添付ファイルの更新と削除
  • 添付ファイルのアクセス権管理
  • Apexからの添付ファイルダウンロードと共有

プログラムによる添付ファイルの更新と削除

Apexコードを使用して添付ファイルを更新する場合、まず対象のファイルを探し、それを取得してから内容を変更します。

以下は既存のAttachmentオブジェクトを検索し、更新する例です。

Attachment att = [SELECT Id, Name, Body FROM Attachment WHERE ParentId = '001xxxxxxxxxxxx' LIMIT 1];
att.Name = 'UpdatedFile.txt';
att.Body = Blob.valueOf('Updated file content');
update att;

ファイルの削除はさらに簡単で、対象となるファイルを検索してからそのレコードを削除します。

Attachment attToDelete = [SELECT Id FROM Attachment WHERE Name = 'ObsoleteFile.txt' LIMIT 1];
delete attToDelete;

指定した名前のファイルを検索し、見つかったらそのファイルをデータベースから削除します。

添付ファイルのアクセス権管理

Apexを使ってファイルのアクセス権を管理することも重要です。

Sharingオブジェクトを使用して、ファイルに対するユーザーやグループのアクセス権を設定できます。

例えば以下のようなコードです。

ContentDocumentLink cdl = new ContentDocumentLink();
cdl.ContentDocumentId = [SELECT Id FROM ContentDocument WHERE Title = 'My Document' LIMIT 1].Id;
cdl.LinkedEntityId = '005xxxxxxxxxxxx'; // ユーザかグループのID
cdl.ShareType = 'V'; // V:ビュー権限, E:編集権限
cdl.Visibility = 'AllUsers';
insert cdl;

この例では、特定のユーザーやグループに対して文書のビュー権限（V）を付与しています。

Apexからの添付ファイルダウンロードと共有

Apexを介して、ユーザーに添付ファイルをダウンロードさせることも可能です。

また、ファイルをユーザー間で共有することも、コードを使って自動化できます。

たとえば、ContentDistributionオブジェクトを使用してファイルを共有する公開リンクを生成してみましょう。

ContentDistribution cd = new ContentDistribution();
cd.Name = 'Shareable Document Link';
cd.ContentVersionId = [SELECT ContentDocumentId FROM ContentVersion WHERE Title = 'SharedDocument' LIMIT 1].ContentDocumentId;
cd.PreferencesAllowViewInBrowser = true;
cd.PreferencesNotifyOnVisit = false;
cd.PreferencesPasswordRequired = false;
cd.PreferencesLinkLatestVersion = true;
insert cd;

ContentDistribution publishedLink = [SELECT DistributionPublicUrl FROM ContentDistribution WHERE Id = :cd.Id];
String publicUrl = publishedLink.DistributionPublicUrl;
// publicUrlをユーザーに提供してファイルへのアクセスを可能にする

このコードは、特定の文書に対する公開リンクを生成し、そのリンクを他のユーザーと共有してファイルアクセスを提供するプロセスを表しています。

添付ファイル挿入のベストプラクティス

添付ファイルの挿入にあたっては、セキュリティ、プライバシー、そしてシステムの限界を常に意識するべきです。

大きなファイルを扱う場合のベストプラクティス、ガバナ制限への対処法、そしてパフォーマンスを最適化する方法について検証します。

  • セキュリティとプライバシーの考慮
  • 大容量ファイルの取り扱い
  • ガバナ制限とパフォーマンスの最適化

セキュリティとプライバシーの考慮

添付ファイルを扱う際は、ファイルのセキュリティとプライバシーに特に注意を払いましょう。

  • ファイルアクセスに関連する権限を適切に設定する
  • ファイルデータを安全な方法で暗号化して保存する

さらに、機密情報を含むファイルは特に慎重に扱うべきです。

例えば、次のようにApexコードで権限チェックをおこなうことで、セキュリティを強化できます。

if (Schema.sObjectType.Attachment.isCreateable()) {
    // ユーザーがAttachmentオブジェクトの作成権限を持っている場合にのみ処理を続行する
}

このコードでは、現在のユーザーがAttachmentオブジェクトを作成する権限があるかどうかを確認しています。

大容量ファイルの取り扱い

大容量のファイルを取り扱う場合、Salesforceのデータストレージの限界やガバナ制限に特に気をつける必要があります。

また、ファイルを小さなチャンクに分割し、非同期処理（例えば、バッチApex）を使って取り扱うことで、限界を避ける戦略が有効です。

ガバナ制限とパフォーマンスの最適化

Salesforceはガバナ制限を持っており、Apexコードが消費できるリソースに制限があります。

そのため、ファイルのアップロードや操作には効率的なコーディングが重要。

不要なDML操作を避け、適切な例外処理を実装し、コードのパフォーマンスを最適化しましょう。

これにより、システムリソースを最大限活用しつつ、速度と信頼性を保てます。

Salesforceのガバナ制限とは？主な内容とその対策
Salesforceのガバナ制限について詳しく知りたいですか？当記事では、SalesforceのApexやVisualforceにおけるガバナ制限の概要と、これらの制限にどう対応するかを詳細に解説します。効率的で安定したSalesforceアプリケーションを開発するために不可欠な情報が満載です。初心者から上級者まで、Salesforce開発の品質と効率を向上させたい方にとって必読の内容です。
itc.tokyo
2023.12.20

添付ファイル挿入に関するトラブルシューティング

こちらでは、Salesforceで添付ファイルを挿入する際によくあるトラブルシューティングのアプローチを提供します。

  • よくある問題とその対処法
  • デバッグとエラーハンドリング
  • テストクラスでの添付ファイル挿入の検証

よくある問題とその対処法

添付ファイルを挿入する際には、以下のような問題が発生することがあります。

  • ファイルサイズの問題
  • 不正なファイルフォーマット
  • 権限不足

これらの問題に対処するひとつの方法は、ファイルを添付する前に有効なファイルサイズとフォーマットを検証することです。

また、try-catchブロックを使用してエラーハンドリングにより、削除されたレコードや権限の変更によるトリガーの実行を防げます。

デバッグとエラーハンドリング

デバッグとエラーハンドリングは、開発プロセスにおいて重要なステップです。

SalesforceではSystem.debugメソッドを使用して、コードの実行中に情報をログに出力が可能。

また、エラーメッセージを明確にするために例外の種類に応じてカスタマイズされたエラーハンドリングを実装することが重要です。

try {
    // 添付ファイル挿入のロジック
    insert att;
} catch (DmlException e) {
    System.debug('An error occurred when inserting the attachment: ' + e.getMessage());
    // エラー時の適切な処理を実装
}

このコード例では、添付ファイルを挿入する際に発生する可能性のあるエラーを捕捉し、詳細な情報をログに記録しています。

テストクラスでの添付ファイル挿入の検証

テストクラスを使用したApexコードの検証はとても重要。

なぜなら品質を保証し、未来のコード変更による潜在的な問題を予防できるからです。

添付ファイルの挿入をテストする際には、適切なテストデータの作成が必要であり、ApexのTest.startTest()とTest.stopTest()メソッドを利用して実際のトランザクションと同じ環境をシミュレートします。

@isTest
private class AttachmentInsertTest {
    static testMethod void testInsertAttachment() {
        Test.startTest();
        // テストデータの設定
        Account testAccount = new Account(Name = 'Test Account');
        insert testAccount;
        // 添付ファイル挿入のテストロジック
        Attachment att = new Attachment(ParentId = testAccount.Id, Name = 'TestFile.txt');
        att.Body = Blob.valueOf('Test content');
        insert att;
        Test.stopTest();
        // アサーションを使用して結果を検証
        Attachment insertedAtt = [SELECT Id, Name FROM Attachment WHERE ParentId = :testAccount.Id];
        System.assertEquals('TestFile.txt', insertedAtt.Name);
    }
}

このテストクラスでは、独立したテストコンテキスト内でアカウントを新規作成し、新しい添付ファイルを挿入した後、期待される結果が得られるかをアサート文で検証しています。

まとめ

SalesforceのApexプログラミング言語を使って添付ファイルを操作する方法について、基礎から応用まで幅広くカバーしました。

添付ファイルの基本的概念から始め、ファイルの挿入方法、操作の実践的応用、ベストプラクティスとトラブルシューティングに至るまで、初心者から中級者を対象に詳細を解説。

Apexを利用したファイルの管理は、Salesforce開発者としてのスキルを高め、より効果的なアプリケーションを作成するために不可欠な要素であることを強調しておさめたいと思います。

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