node-red-contrib-salesforce-chatter
Version:
A processing node of Node-RED nodes for Salesforce Chatter.
84 lines (73 loc) • 6.12 kB
HTML
<script type="text/x-red" data-help-name="force" data-lang="ja">
<p>force.comへのログイン情報を設定します。このノードでは以下の3通りのログイン方法を使用します。</p>
<ul>
<li>ユーザ名/パスワードでログイン:
<p>ユーザ名(<code>User Name</code>)とパスワード(<code>Password</code>)を設定します。</p>
</li>
<li>OAuth2でログイン:
<p>OAuth2でログインをする場合、salesforceの設定→作成→アプリケーションで接続アプリケーションを作成します。</p>
<p>このとき、ノードの設定画面に表示されているリダイレクトURLを接続アプリケーションのコールバックURLに指定します。</p>
<p>ユーザ名(<code>User Name</code>)とコンシューマ鍵(<code>Client Id</code>)、コンシューマの秘密(<code>Client Secret</code>)を設定し、<code>Authenticate with Force</code>ボタンをクリックしてログイン情報を取得します。</p>
</li>
<li>署名済みリクエストでログイン:
<p>署名済みリクエストでログインをする場合、salesforceの設定→作成→アプリケーションで接続アプリケーションを作成します。</p>
<p>ユーザ名(<code>User Name</code>)、コンシューマの秘密(<code>Client Secret</code>)を設定します。</p>
</li>
</ul>
</script>
<script type="text/x-red" data-help-name="force in" data-lang="ja">
<p>force.com ノード。<code>Operation</code>で選択した以下の処理を実行します。</p>
<ul>
<li>検索</li>
<li>作成</li>
<li>更新</li>
<li>作成/更新</li>
<li>削除</li>
</ul>
<h3>入力</h3>
<dl class="message-properties">
<dt class="optional">payload
<span class="property-type">文字列 | 配列 | オブジェクト</span>
</dt>
<dd> 選択した処理を実行するデータを入力します。 </dd>
</dl>
<h3>出力</h3>
<dl class="message-properties">
<dt>payload <span class="property-type">配列 | オブジェクト</span></dt>
<dd>選択した処理の実行結果を出力します。</dd>
</dl>
<h3>詳細</h3>
<h4>検索</h4>
<p> <code>msg.payload</code>で受け取ったSOQLクエリにて検索を実行します。受信可能なプロパティタイプは<code>文字列</code>です。 </p>
<p> <code>msg.payload = "select Id, Name from Account";</code></p>
<p> <code>maxFetch value</code>に取得したい件数を設定します。<code>maxFetch value</code>を設定しない場合は、最大10,000件取得します。</p>
<p>取得した検索結果は<code>msg.payload</code>にjsonオブジェクトにて格納して出力します。</p>
<h4>作成: </h4>
<p> <code>msg.payload</code>で受け取ったjsonオブジェクトデータをもとに設定したオブジェクトにデータを新規作成します。プロパティタイプは<code>オブジェクト</code>または<code>配列</code>です。 </p>
<p> <code>msg.payload = {Name: 'hoge'};</code><br>
<code>msg.payload = [{Name: 'hoge'},{Name: 'fuga'}];</code></p>
<p> <code>Sobject</code>にデータを作成するオブジェクトのオブジェクト名(API参照名)を設定します。</p>
<p>作成の実行結果は<code>msg.payload</code>にjsonオブジェクトにて格納して出力します。</p>
<h4>更新: </h4>
<p> <code>msg.payload</code>で受け取ったjsonオブジェクトデータをもとにデータを更新します。プロパティタイプは<code>オブジェクト</code>または<code>配列</code>です。 </p>
<p> <code>msg.payload = {Id: '00000', Name: 'hogehoge'};</code><br>
<code>msg.payload = [{Id: '00000', Name: 'hogehoge'},{Id: '11111', Name: 'fugafuga'}];</code></p>
<p> <code>Sobject</code>にデータを更新するオブジェクトのオブジェクト名(API参照名)を設定します。</p>
<p>更新の実行結果は<code>msg.payload</code>にjsonオブジェクトにて格納して出力します。</p>
<h4>作成/更新: </h4>
<p> <code>msg.payload</code>で受け取ったjsonオブジェクトデータをもとにデータを新規作成または更新します。プロパティタイプは<code>オブジェクト</code>または<code>配列</code>です。 </p>
<p> <code>msg.payload = {key__c: 'key1', Name: 'hoge'};</code><br>
<code>msg.payload = [{key__c: 'key1', Name: 'hoge'},{key__c: 'key2', Name: 'fuga'}];</code></p>
<p> <code>Sobject</code>にデータを作成または更新するオブジェクトのオブジェクト名(API参照名)を設定します。</p>
<p> <code>External ID field name</code>にデータの作成または更新を判定するキーとなる外部ID項目の項目名(API参照名)を設定します。</p>
<p>作成/更新の実行結果は<code>msg.payload</code>にjsonオブジェクトにて格納して出力します。</p>
<h4>削除: </h4>
<p> <code>msg.payload</code>で受け取ったjsonオブジェクトデータをもとにデータを削除します。プロパティタイプは<code>文字列</code>または<code>配列</code>です。 </p>
<p> <code>msg.payload = "['00000']";</code><br>
<code>msg.payload = ['00000', '11111'];</code></p>
<p> <code>Sobject</code>にデータを削除するオブジェクトのオブジェクト名(API参照名)を設定します。</p>
<p>削除の実行結果は<code>msg.payload</code>にjsonオブジェクトにて格納して出力します。</p>
<p>更新や削除時に入力するデータのオブジェクトIdは、forceノード(検索)の実行結果を利用すると便利です。</p>
<pre>msg.record = msg.payload;
msg.payload = { Id: msg.record[0].Id };</pre>
</script>