Bring Your Own Channel(BYOC)は、FinのユーザーがFin MessengerをライブチャットAIエージェントとして利用できる新しい方法です。Enhanced ChatではなくBYOCで接続することで、複数タブでの同時会話など特定のユーザー行動の処理が改善され、Finの最高品質のサービスを引き続き享受できます。移行は簡単で、テスト環境を利用して本番環境にダウンタイムなしで展開できます。以下のガイドに従ってワークスペースに実装してください。
この記事を使って、既存のFin for Salesforce接続を新しいExternal Client App(ECA)にアップグレードしてください。このガイドは既存のFin for Salesforce導入を移行するSalesforce管理者向けです。Salesforce管理者アクセス権と有効なFin for Salesforceサブスクリプションが必要です。最後には必要な管理パッケージをインストールし、新しいECAで接続し、権限を設定し、Fin Messengerを使用している場合はBring Your Own Channel(BYOC)を介してFinとSalesforce間のライブチャット接続を確立します。BYOCはSalesforceの標準チャネル統合フレームワークで、サードパーティのメッセージングプロバイダーを接続します。
手順は6ステップあります:
External Client Appを介してSalesforceに接続する
権限を設定する
External Client Appの資格情報を使用するよう切り替える
Apex移行スクリプトを実行する
非推奨パッケージをアンインストールし、Connected Appの接続を解除する
Fin Messengerの導入を更新する
[任意]
注意: SalesforceのケースのみをFinで処理する場合(メッセージングなし)は、以下のFin Messengerの更新セクションはスキップできます。
ステップ1:External Client Appを介してSalesforceに接続する
FinワークスペースのConnectに移動し、Bring Your Own Channelタブをクリックします。
これは新しいExternal Client App(ECA)への移行タブです。ECAはOAuth 2.0クライアント資格情報ベースの認証方式で、ユーザー資格情報の保存を必要とした旧Connected App(OAuthベースの統合)に代わるものです。
このタブには既存の接続がNot Connectedとして表示されます。接続状態はExternal Client Appに関するものです。
以下の手順に従い、Salesforceに管理パッケージをインストールしてください。管理パッケージはExternal Client Appと、Finが動作するために必要なすべての権限とフィールドをインストールします。
接続したい既存の接続(テストまたは本番)のConnectボタンをクリックし、次にInstall Packageをクリックします。
Install for all usersを選択します。これにより、権限セットはSalesforce組織内の任意のユーザーに割り当て可能になります。
インストールが完了するまで待ちます。エラーは表示されないはずです。
インストール完了後、Connectページに戻り、ステップ2のConnect to Salesforceボタンをクリックして接続を確立してください。
Fin for Salesforce管理パッケージはサンドボックスと本番組織の両方にインストール可能なリリース版です。インストール後、Installed Packagesにfinai名前空間とFinがパブリッシャーとして表示されます。
ステップ2:権限を設定する
FinワークスペースのConnect > External Client App (Tab) > Assign permissions in Salesforceに移動し、そこで新しい権限セットを作成し、Finが動作するために必要なすべての権限を割り当てる手順に従ってください。
新しい権限セットを作成する
Salesforceで新しい権限セットを作成します。ラベルとAPI名は任意です。この権限セットは統合ユーザーにのみ割り当てられます。
ライセンス選択時には、Set Audit Fields upon Record Creation権限を含むもの(例:Salesforceライセンス)を選択してください。一部のライセンスにはこの権限が含まれていません。
新しい権限セットを保存します。
注意: すべてのSalesforceライセンスタイプにSet Audit Fields upon Record Creation権限が含まれているわけではありません。このオプションが利用できない場合は、標準のSalesforceライセンスなど、権限を含む別のライセンスを選択してください。
統合ユーザーに権限セットを割り当てる
既存のFin for Salesforce permissions権限セットと新規作成した権限セットの両方を統合ユーザーに割り当てる必要があります。
Salesforceで統合ユーザーのプロファイルに移動します。
Permission Set Assignmentsに移動し、Edit Assignmentsをクリックします。
Fin for Salesforce permissions権限セットと新規作成した権限セットの両方をEnabled Permission Sets列に追加し、Saveをクリックします。
ステップ3:External Client Appの資格情報を使用するよう切り替える
Salesforce接続の管理時にConnect > External Client App (Tab)でUse External Client App credentialsを切り替えることで、External Client Appの資格情報を使用するよう切り替えられます。
切り替え後、FinはSalesforceへのすべてのリクエストにExternal Client Appの資格情報を使用します。例えば:
接続状態を取得するクエリ。
workflowステップを介したSalesforceケースの作成。
Finの解決時またはユーザー非アクティブ時のSalesforceケース作成。
Salesforceケースチャネル経由で作成されたケースへの対応。
Knowledge記事のインポート。
過去のSalesforceケースのインポート。
切り替え後、問題があると思われる場合は元に戻すことも可能です。これにより、サンドボックス、UAT(ユーザー受け入れテスト)、本番の各環境でテストし、新しいECA資格情報に自信を持てます。旧Connected App資格情報を妨げません。
すべての接続でUse External Client App credentialsがオンになると、移行は完了です。各エントリの接続状態はExternal Client AppタブでConnectedに更新されます。すべてが正常に動作していることを確認したら、以下の手順に従いデータを移行し、非推奨パッケージをクリーンアップしてください。
ステップ4:Apex移行スクリプトを実行する
Fin for Salesforce基本管理パッケージをインストールすると、finai名前空間付きの新しいFin Caseフィールドがインストールされます。名前空間とは、フィールド名の前にfinai__(例:finai__FinConversationId__c)が付くことで、他のパッケージやカスタムフィールドとの名前衝突を防ぐ仕組みです。
移行の一環として、Apex移行スクリプトを使い、既存の名前空間なしフィールドから新しい名前空間付きフィールドへケースデータを移動します。Fin for Salesforceパッケージには移行ロジックを処理するFinCaseFieldMigrator.clsという事前構築済みApexクラスが含まれています。
管理パッケージ内のApexは、修飾されていないカスタムフィールド名を自身の名前空間に対して解決します。finaiパッケージ内で実行されるFinConversationId__cのクエリは代わりにfinai__FinConversationId__cを返すため、パッケージ化されたコードはレガシーフィールドをまったく読み取れず、両方を1つのクエリで指定するとduplicate field selectedエラーで完全に失敗します。したがって、マイグレーションの取得はパッケージの外部から実行する必要があります。これが、以下のクラスを手動で組織に追加する必要がある理由です。これらのクラス自体にはマイグレーションロジックはなく、管理パッケージによってインストールされたマイグレーションクラスを呼び出し、一度に200レコードずつバッチで実行します。
組織に2つのApexクラスを追加し、マイグレーションを一度実行してから、不要になったら両方のクラスを削除します。
FinCaseFieldMigration はマイグレーションを実行します。
FinCaseFieldMigrationTest はそのテストです。SalesforceはテストなしでApexを本番環境にデプロイしません。このテストは実行前に組織の設定が正しいかも確認します。
4a. 2つのクラスをコピーします
FinCaseFieldMigration
public without sharing class FinCaseFieldMigration implements Database.Batchable<SObject>, Database.Stateful {
private final finai.FinCaseFieldMigrator migrator;
public FinCaseFieldMigration() {
this.migrator = new finai.FinCaseFieldMigrator();
}
public static Id run() {
return run(200);
}
public static Id run(Integer scopeSize) {
if (scopeSize == null || scopeSize < 1 || scopeSize > 2000) {
throw new IllegalArgumentException('scopeSize must be between 1 and 2000, got: ' + scopeSize);
}
return Database.executeBatch(new FinCaseFieldMigration(), scopeSize);
}
public Database.QueryLocator start(Database.BatchableContext bc) {
return Database.getQueryLocator(migrator.queryString());
}
public void execute(Database.BatchableContext bc, List<SObject> scope) {
migrator.migrate(scope);
}
public void finish(Database.BatchableContext bc) {
migrator.report(bc.getJobId());
}
}
FinCaseFieldMigrationTest
@IsTest
private class FinCaseFieldMigrationTest {
private static final String LEGACY_FIELD = 'FinConversationId__c';
private static final String TARGET_FIELD = 'finai__FinConversationId__c';
// Absent legacy field means the old unlocked package was never installed here, so there is
// genuinely nothing to migrate and the test below has nothing to prove. Every other
// precondition is a misconfiguration and is asserted, so it fails the deploy rather than
// passing green on a migration that would silently copy nothing.
private static Boolean orgHasLegacyField() {
return Schema.SObjectType.Case.fields.getMap().containsKey(LEGACY_FIELD);
}
@IsTest
static void copiesLegacyDataOntoTheNamespacedField() {
if (!orgHasLegacyField()) {
return;
}
Map<String, Schema.SObjectField> fields = Schema.SObjectType.Case.fields.getMap();
System.assert(
fields.containsKey(TARGET_FIELD),
TARGET_FIELD + ' does not exist — install the finai managed package before this class'
);
System.assert(
fields.get(LEGACY_FIELD).getDescribe().isAccessible(),
'cannot read ' + LEGACY_FIELD + ' — the legacy permission set must stay assigned'
);
System.assert(
fields.get(TARGET_FIELD).getDescribe().isUpdateable(),
'cannot write ' + TARGET_FIELD + ' — assign finai__Fin_for_Salesforce_permissions'
);
Case seeded = new Case(Subject = 'fin case field migration test', Status = 'New');
seeded.put(LEGACY_FIELD, 'conv-under-test');
insert seeded;
Id seededId = seeded.Id;
Test.startTest();
FinCaseFieldMigration.run();
Test.stopTest();
SObject migrated = Database.query(
'SELECT Id, ' + TARGET_FIELD + ' FROM Case WHERE Id = :seededId LIMIT 1'
)[0];
System.assertEquals(
'conv-under-test',
migrated.get(TARGET_FIELD),
'the legacy value should have been copied onto the namespaced field'
);
}
@IsTest
static void runReturnsAJobId() {
Test.startTest();
Id jobId = FinCaseFieldMigration.run(50);
Test.stopTest();
System.assertNotEquals(null, jobId, 'run() should return the id of the batch job it queued');
}
@IsTest
static void runRejectsAScopeSizeOutsideTheBatchLimits() {
for (Integer scopeSize : new List<Integer>{ null, 0, 2001 }) {
try {
FinCaseFieldMigration.run(scopeSize);
System.assert(false, 'expected IllegalArgumentException for scopeSize ' + scopeSize);
} catch (IllegalArgumentException e) {
System.assert(
e.getMessage().contains('scopeSize must be between 1 and 2000'),
'unexpected message: ' + e.getMessage()
);
}
}
}
}
4b. クラスをSalesforce組織に追加します
追加方法はマイグレーション対象の組織によって異なります。
サンドボックスのマイグレーション
設定 > Apex クラス に移動し、新規をクリックします。
FinCaseFieldMigration のコードを貼り付けて、保存をクリックします。
再度新規をクリックし、FinCaseFieldMigrationTestのコードを貼り付けて、保存をクリックします。
すべてのテストを実行をクリックするか、FinCaseFieldMigrationTestを開いてテストを実行をクリックし、合格を確認します。
変更セットを使った本番環境のマイグレーション(コマンドライン不要)
本番組織では設定からApexクラスを作成できないため、サンドボックスで作成してそこからデプロイします。
新しいパッケージがインストールされたサンドボックスで、上記のように両方のクラスを作成します。
サンドボックスで設定 > 送信変更セットに移動し、新規をクリックします。両方のApexクラスを追加し、ターゲットとして本番組織を選択してアップロードをクリックします。
本番環境で設定 > デプロイ設定に移動し、サンドボックスが受信変更を送信できるように許可されていることを確認します。
本番環境で設定 > 受信変更セットに移動し、変更セットを開いてデプロイをクリックします。
テストオプションの選択で「指定したテストを実行」を選択し、FinCaseFieldMigrationTestを入力してデプロイをクリックします。
Salesforce CLIを使った本番環境のマイグレーション
各クラスをcase-field-migration/classes/フォルダに.clsファイルとして保存します。各ファイルの隣に同名の.cls-meta.xmlファイル(例:FinCaseFieldMigration.cls-meta.xml)を作成し、以下を含めます:
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<apiVersion>62.0</apiVersion>
<status>Active</status>
</ApexClass>
次に以下を実行します:
sf project deploy start \
--source-dir case-field-migration \
--target-org <your-org-alias> \
--test-level RunSpecifiedTests \
--tests FinCaseFieldMigrationTest
成功したデプロイが示すこと:デプロイ中にテストが一時的なテスト用Caseを作成し、それをマイグレーションし、新しいフィールドに値が到達したことを確認します。Salesforceはテストデータをその後ロールバックします。したがって、成功したデプロイはマイグレーションがすでに組織で機能していることを意味します。デプロイが失敗した場合、エラーメッセージはパッケージの欠如や権限セットの不足など理由を示します。
4c. マイグレーションを実行します
Salesforce設定 > 開発者コンソールに移動します。
デバッグ > 匿名実行ウィンドウを開くをクリックします。
以下のコードを貼り付け、実行をクリックします。
Id jobId = FinCaseFieldMigration.run();
System.debug('Fin Case field migration job: ' + jobId);
マイグレーションはデフォルトで1バッチあたり200件のCaseを処理します。組織にCaseトリガー、フロー、その他の自動化があり、そのサイズでガバナ制限に達する場合は、代わりに小さいバッチサイズを使用してください。FinCaseFieldMigration.run(50);
4d. 結果を確認します
設定 > ApexジョブでFinCaseFieldMigrationジョブの進行状況を表示します。
ジョブが終了すると、開始した管理者にレポートメールが届きます。スキップまたは失敗したすべてのCaseがフィールドと理由とともにリストされます。
実行が成功したと仮定せずにレポートを読んでください。実行時に権限セットが不足していると、ジョブは何もコピーせずに「成功」として終了することがあります。レポートはスキップしたフィールドを教えてくれます。
マイグレーションは安全に再実行できます。空の新しいフィールドだけを埋めるため、2回目の実行ではレコードは更新されません。
マイグレーションで行わないこと:
古いフィールドの削除や変更は行いません。
元に戻すことはできません。
2つのチェックボックス、Fin Involved と Fin Marked As Spam は、古い値がチェックされている場合のみコピーされます。チェックされていないボックスは設定されていないものと区別できないためコピーされません。いずれにせよ、新しいフィールドはチェックされていません。
4e. クラスを削除します
レポートがクリーンな実行を示したら、FinCaseFieldMigration と FinCaseFieldMigrationTest の両方を削除してください。これをスキップすると、これらのクラスが組織にある間はSalesforceがFin for Salesforceパッケージのアンインストールを許可しません。
サンドボックス: 設定 > Apex クラス に移動し、各クラスの横にある削除をクリックします。
本番環境: 本番環境では設定からApexを削除できないため、Salesforce CLIを使用してください。
空のフォルダにdestructiveChanges.xml:を作成します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>FinCaseFieldMigration</members>
<members>FinCaseFieldMigrationTest</members>
<name>ApexClass</name>
</types>
</Package>同じフォルダにpackage.xmlファイルを作成します。
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<version>62.0</version>
</Package>そのフォルダから以下を実行します。
sf project deploy start \
--manifest package.xml \
--post-destructive-changes destructiveChanges.xml \
--target-org <your-org-alias> \
--test-level RunLocalTestsこれは本番デプロイ時と同様に組織の既存テストを実行します。FinCaseFieldMigrationTest以外のテストで失敗した場合、そのテストに問題があり、マイグレーションの問題ではありません。通常のデプロイと同様に修正してください。
ステップ5:廃止されたパッケージをアンインストールし、Connected Appの接続を解除します。
新しい管理パッケージがインストールされ、すべての接続がECA資格情報に切り替わり、Fin Caseフィールドデータが新しい名前空間付きフィールドにマイグレーションされたら、以前のアンロックまたはアンマネージドパッケージをアンインストールし、レガシーConnected Appの接続を取り消します。
アンインストールするパッケージ: 組織には現在2つのFinパッケージがあります。名前空間プレフィックスがなく、発行元がIntercomのレガシーアンロックパッケージのみをアンインストールしてください。これはFin for Salesforceとして、またはIntercomFinAIPermissionsなど別名で表示されることがあります。finai名前空間を持ち、発行元がFinの新しい管理パッケージは保持してください。
レガシーPermissionSetの割り当て解除
パッケージをアンインストールする前に、レガシーPermissionSet(特定の機能やフィールドへのアクセスをusersに付与するSalesforceオブジェクト)の割り当てを解除する必要があります。
レガシーパッケージと新しいmanaged packageの両方に、Fin for Salesforce permissionsというラベルのpermission setが含まれています。namespaceプレフィックスがないレガシーのものだけ割り当て解除してください。finai__Fin_for_Salesforce_permissionsはintegration userに割り当てたままにしてください。
パッケージのいずれにも属さない他のFin関連のpermission setが見つかった場合、それらはおそらく組織内で手動作成されたものです。FinがExternal Client Appで動作している限り、割り当てられたusersがいなければ削除できます。
Salesforce setup > Installed Packagesに移動します
レガシーのFin for Salesforceアンロックパッケージ(namespaceプレフィックスなし)をクリックします
View Componentsをクリックします
Fin_for_Salesforce_permissions PermissionSetをクリックすると、PermissionSetページに移動します。
Manage Assignmentsをクリックします
割り当てられているすべてのSalesforce Usersを選択します
Remove Assignmentボタンをクリックします
パッケージをアンインストールしてデータを保存します
Salesforce setup > Installed Packagesに移動します
レガシーのFin for Salesforceアンロックパッケージ(namespaceプレフィックスなし)の横にあるUninstallをクリックします
Uninstall後48時間、このパッケージのデータのコピーを保存するを選択すると、Salesforce Case IDの列を含むcsv形式で全てのケースフィールドデータが保存されます。
重要:Salesforceはアンインストール後48時間のみ保存されたデータエクスポートを保持します。その期間内にCSVをダウンロードしてください。すでにApex移行スクリプトを正常に実行していれば、このファイルからの復元は不要ですが、安全策として役立ちます。
パッケージのアンインストールが正常に完了した通知を待ちます。
Salesforce setup > Installed Packagesに戻ると、アンインストール済みパッケージがUninstalled Packagesの下に表示されます。
Dataをクリックすると、全てのケースデータがcsv形式でzipファイル内にダウンロードされます。このzipファイルは安全に保管してください。必要に応じてデータ復元に使用できます。ただし、Apex移行スクリプトを実行済みなら問題ありません。
Connected App接続を取り消す
Connected Appのトークンは各Salesforce組織に別々に保存されるため、sandboxやUAT組織で取り消しても本番環境の接続には影響しません。各組織では、Fin接続がUse External Client App credentialsをオンにして正常に動作していることを確認してからトークンを取り消してください。
Salesforce setup > Connected Apps OAuth Usageに移動します
Fin for Salesforce Connected AppのUser Count列の下にある数字リンクをクリックします。Connected App User's Usageにリダイレクトされます。
リストにある各ユーザーの横にあるRevokeをクリックします。これによりレガシーConnected App接続のOAuthアクセストークンが削除されます。取り消すと、そのユーザーはリストから消えます。
ステップ6:Fin Messengerの展開を更新する
Fin for SalesforceをMessagingで使用する場合のみ、以下の手順に従ってください。
このセクションでは、SalesforceでFinをBring Your Own Channel(BYOC)パートナーとして接続し、既存のEnhanced ChatハンドオフworkflowsをBYOCに移行する方法を説明します。
FinをBring Your Own Channelに接続する
FinとSalesforce間のBYOC接続を確立するには、Fin Messenger: Setting up with Salesforceの記事のステップ1に従ってください。このステップではMessaging Channelの作成、Event Relayの設定、Salesforceでのチャネル有効化を案内します。
完了すると、FinとSalesforce間に稼働中のEvent Relayを備えたアクティブなMessaging Channelができます。Event RelayはSalesforceの機能で、リアルタイムのプラットフォームイベントをストリームし、ここではFinとSalesforce間のメッセージ送受信に使用されます。
Salesforceエージェントへのハンドオフ
Fin Messenger workflowsのHand-off to Salesforce agentステップは、BYOCとEnhanced Chatの切り替えをサポートしています。これにより、テスト中にどのチャネルを使用するか制御でき、ダウンタイムなしで段階的に切り替え可能です。
異なるaudienceと環境ターゲティングで複数のworkflowsを作成し、どのトラフィックをBYOC経由にするか制御できます。
または、workflowsのBranchesステップでEnvironment変数を使い、BYOCオンのHand-off to Salesforce agentステップとBYOCオフ(Enhanced Chat)のステップに振り分けることも可能です。
よくある質問
移行にはどのくらい時間がかかりますか?
移行にはどのくらい時間がかかりますか?
技術的な手順自体は通常1〜2時間です。ただし、sandbox、UAT(ユーザー受け入れテスト)、本番の順に完全なテストサイクルを実施する場合は、全体で1〜2営業日かかります。主な変動要因は、本番稼働前に検証するSalesforce環境の数です。
ダウンタイムはありますか?
ダウンタイムはありますか?
ダウンタイムは想定されていません。Use External Client App credentialsの切り替えは問題があればいつでも戻せますし、Enhanced ChatとBYOCは移行期間中同時に稼働可能です。
移行を本番環境に展開する順序は?
移行を本番環境に展開する順序は?
まずsandboxまたはUAT組織で完全な移行を完了・検証してください。その後、本番環境で:
Fin for Salesforce managed packageをインストールします(ステップ1)。
新しいpermission setを作成し、両方のpermission setをintegration userに割り当てます(ステップ2)。移行スクリプトが旧フィールドを読み取るため、レガシーpermission setは当面割り当てたままにしてください。
External Client App経由で接続し、本番接続でUse External Client App credentialsをオンにします(ステップ3)。
sandboxからchange setまたはSalesforce CLIを使って2つの移行クラスを展開し、移行を実行、レポートメールを確認後、クラスを削除します(ステップ4)。
レガシーの権限セットの割り当てを解除し、レガシーパッケージをアンインストールし、Connected Appトークンを取り消します(ステップ5)。
ダウンタイムは発生しません。External Client Appの接続が正常に動作していることを確認できるまでは、レガシーのConnected Appトークンをそのままにしておいてください。Finはトグルをオフに戻した場合にそれらを使用します。
追加のSalesforceライセンスやアドオンは必要ですか?
追加のSalesforceライセンスやアドオンは必要ですか?
BYOC経由でSalesforceのエージェントにライブチャットを引き継ぐためにFin Messengerを使用する場合のみ必要です。その場合、BYOCを含むSalesforceライセンスが必要です。例えば、Digital Engagement SKU with the Partner Messaging add-onや、Agentforce Contact Center DigitalのようなBYOCを含む新しいSKUです。どのSKUでもBYOCが含まれていれば問題ありません。FinをSalesforce Casesのみに使用する場合や、Fin MessengerがSalesforce Caseを作成して引き継ぐ場合は、このライセンスは不要です。関連ライセンスがあるか確認する方法の一つは、
Salesforce setup > Company Informationに移動します。
Permission Set Licensesの下にPartner Messaging Userがリストされているか、利用可能なライセンスの合計数を確認します。
ライセンスやアドオンが不足している場合、またはFinチャットを担当するエージェントの必要ライセンス数を確認するために、Salesforceのアカウントエグゼクティブ(AE)に連絡してください。
既存のSalesforceデータが上書きされるリスクはありますか?
既存のSalesforceデータが上書きされるリスクはありますか?
以前のアンロック/アンマネージドパッケージをアンインストールする際に、データ(特にFinカスタムCaseフィールド)が失われるリスクがあります。
しかし、これはApex移行スクリプトの実行や、アンインストール時にCaseデータのダウンロードによって軽減されます。
この移行に関しては、既存のSalesforceデータが上書きされるリスクはありません。












