例: Salesforce オポチュニティー管理用のカスタム Process App の作成

プロセスアプリの作成ウィザードにアクセスします：

1. ホーム画面で「 Start from a process application 」タイルをクリックします。
2. プロセスアプリのダッシュボードで、 プロセスアプリの作成をクリックして、 プロセスアプリの作成ウィザードを開きます。

サマリーカードのステップでは、以下のステップを完了する：

1. Name 欄にプロセスアプリの名前 「 Salesforce Opportunities 」を入力する。

2. 「要旨」 フィールドに、Process App に関する説明を入力します。

3. トグルを 「クローズド・ソース (Closed source)」 または 「オープン・ソース (Open source)」 に切り替えて、Process App ユーザーの権限を設定します。 要件に応じて、以下のいずれかのオプションを選択できます。

   • Process App ユーザーに 「使用」、 「表示」、 「エクスポート」、および 「複製」 の各権限を付与する場合は、トグルを 「オープン・ソース」 に切り替えます。

   • Process App ユーザーに 「使用」 権限と 「エクスポート」 権限のみを付与する場合は、トグルを 「クローズド・ソース」 に切り替えます。

   プロセスアプリのパーミッションの詳細については、 カスタムプロセスアプリのユーザーの種類とパー ミッションを参照してください。

4. オプション: アイコンをカスタマイズし、サマリーカードに機能のハイライトとドキュメントリンクを追加したい場合は、 カスタマイズセクションを展開してください。 カスタマイズセクションの設定については、 サマリーカードの作成を参照してください。

5. 「次へ」 ボタンをクリックして、 「Process App ロジックのアップロード」 ステップに進みます。

このステップでは、データ抽出と変換を実行するpythonファイルを提供する必要があります。 この場合、 Salesforce に接続し、データを収集し、それを IBM Process Mining. Python スクリプトの作成に役立つコードテンプレートを使用できます。 テンプレートをダウンロードするには、 テンプレートのダウンロード のリンクをクリックしてください。

以下のステップでは、 Salesforce オポチュニティー管理プロセス用の Python スクリプトの作成について詳しく説明します。

1. インポート・ライブラリーを定義します。

       import requests
       import json
       from requests.models import PreparedRequest
       from process_app import ProcessAppException
   

2. パラメーター contextを含む execute という名前のメソッドを組み込みます。

       def execute(context):
   

   context パラメーターには、 Python スクリプトを書くために必要なすべてのコンテキスト情報が含まれている。

3. Connected App で構成した OAuth パラメーターと、 Salesforce アカウント資格情報を使用して、Process App と Salesforceの間の接続をセットアップします。

       # reading data from accelerator config
           consumerKey = config['<consumerKey>']
           secret = config['<consumerSecret>']
           username = config['<username>']
           password = config['<password>']
   

4. Process App と Salesforceの間の接続に失敗した場合の例外メッセージを定義します。

       if consumerKey=='' or secret =='' or username =='' or password =='':
           raise ProcessAppException('configuration not valid')
   

5. プロセスおよび例外の Salesforce アカウント・ログを定義します。

       # login to salesforce
   
       loginParams = {'client_id': consumerKey,'client_secret': secret,
       'grant_type': 'password','username':username,
       'password':password}
       req = PreparedRequest()
       req.prepare_url('https://login.salesforce.com/services/oauth2/token', loginParams)
   
       loginResponse = requests.post(req.url)
       if loginResponse.status_code != 200 :
           raise ProcessAppException('cannot log to salesforce account')
       data = loginResponse.json()
       accessToken = data.get('access_token')
       instanceUrl = data.get('instance_url') 
   

6. 抽出する必要があるイベント・ログを定義します。

       events = []
       importOpportunityCreation(accessToken, instanceUrl, events)
       importOpportunityChange(accessToken, instanceUrl, events)
   

7. 抽出されたデータで返す必要があるイベント属性を定義します。

       df = pd.DataFrame(events,
       columns= ['opportunityId', 'activity', 'startTime', 'resource', 'opportunityAmount', 'opportunityStage'])
   
       return df
   

8. Salesforce で SOQL 照会を定義してデータを抽出します。

       def runSOQLQuery(query, accessToken, instanceUrl, nextRecordsUrl=None):
           req = PreparedRequest()
           if nextRecordsUrl != None:
           req.prepare_url(instanceUrl+nextRecordsUrl, {} )
               else:
           req.prepare_url(instanceUrl+'/services/data/v39.0/query/', {'q' : query})
           queryResponse = requests.get(req.url,
           headers={'Authorization': 'Bearer ' + accessToken})
   
           if queryResponse.status_code != 200 :
           raise Exception('cannot perform SOQL query to salesforce account')
               return queryResponse.json()
   

9. OpportunityCreationのデータ・テーブルを抽出して変換するための SOQL 照会を定義します。

       def formatDate(date):
           return date[0: date.find('.')].replace('T', ' ')
       
       def importOpportunityCreation(accessToken, instanceUrl, events, nextRecordsUrl=None):
           queryResults = runSOQLQuery('Select Id, Amount, StageName, CreatedBy.Name from Opportunity ', accessToken, instanceUrl, nextRecordsUrl)
           
           records = queryResults.get('records')
           for record in records:
               resource = record.get('CreatedBy').get('Name')
               createDate = formatDate(record.get('CreatedDate'))
               amount = record.get('Amount')
           
           events.append([ record.get('Id'),'Create Opportunity', createDate, resource, '0' if 'null' == amount else amount, record.get('StageName') ])
           
           if queryResults.get('nextRecordsUrl') != None :
               importOpportunityCreation(accessToken, instanceUrl, events, queryResults.get('nextRecordsUrl'))
   

10. OpportunityChangeのデータ・テーブルを抽出して変換するための SOQL 照会を定義します。

        def importOpportunityChange(accessToken, instanceUrl, events, nextRecordsUrl=None):
        
            queryResults = runSOQLQuery('Select OpportunityId, CreatedBy.Name, CreatedDate,' + ' Field, NewValue, OldValue from OpportunityFieldHistory', accessToken, instanceUrl, nextRecordsUrl)
    
            records = queryResults.get('records')
            for record in records:
                resource = record.get('CreatedBy').get('Name')
                opportunityId = record.get('OpportunityId')
                createDate = formatDate(record.get('CreatedDate'))
                field = record.get('Field')
                
                if 'StageName' == field:
                    activity='Set Opportunity to ' + record.get('NewValue')
                elif 'Owner' == field:
                    activity='Change opportunity Owner'
                elif 'AccountId' == field:
                    activity = 'Change opportunity Account'
                elif 'Amount' == field:
                    activity= 'Change opportunity Amount'
                
                events.append([ opportunityId, activity, createDate, resource, 0, ‘’ ])
    
            if queryResults.get('nextRecordsUrl') != None :
                importOpportunityChange(accessToken, instanceUrl, events,
                    queryResults.get('nextRecordsUrl'))
    

完全な Python スクリプトを含む以下のコード・スニペットをコピーして使用できます。

    import requests
    import json
    from requests.models import PreparedRequest
    from process_app import ProcessAppException
    def execute(config):
        # reading data from accelerator config
        consumerKey = config['consumerKey']
        secret = config['consumerSecret']
        username = config['username']
        password = config['password']

        if consumerKey=='' or secret =='' or username =='' or password =='':
            raise ProcessAppException('configuration not valid')
   
        # login to salesforce

        loginParams = {'client_id': consumerKey,'client_secret': secret,'grant_type': 'password','username':username,'password':password}
        req = PreparedRequest()
        req.prepare_url('https://login.salesforce.com/services/oauth2/token', loginParams)

        loginResponse = requests.post(req.url)
        if loginResponse.status_code != 200 :
            raise ProcessAppException('cannot log to salesforce account')
        data = loginResponse.json()
        accessToken = data.get('access_token')
        instanceUrl = data.get('instance_url')

        events = []

        importOpportunityCreation(accessToken, instanceUrl, events)
        importOpportunityChange(accessToken, instanceUrl, events)

        df = pd.DataFrame(events,columns= ['opportunityId', 'activity', 'startTime', 'resource',
        'opportunityAmount', 'opportunityStage'])

        return df

    # SOQL query to extract data
    def runSOQLQuery(query, accessToken, instanceUrl, nextRecordsUrl=None):
       req = PreparedRequest()
       if nextRecordsUrl != None:
        req.prepare_url(instanceUrl+nextRecordsUrl, {} )
            else:
        req.prepare_url(instanceUrl+'/services/data/v39.0/query/', {'q' : query})
        queryResponse = requests.get(req.url,
        headers={'Authorization': 'Bearer ' + accessToken})

        if queryResponse.status_code != 200 :
        raise Exception('cannot perform SOQL query to salesforce account')
            return queryResponse.json()
    
    # retrieve data for opportunity creation
    def formatDate(date):
            return date[0: date.find('.')].replace('T', ' ')
        
    def importOpportunityCreation(accessToken, instanceUrl, events, nextRecordsUrl=None):
        queryResults = runSOQLQuery('Select Id, Amount, StageName, CreatedBy.Name from Opportunity ', accessToken, instanceUrl, nextRecordsUrl)
        
        records = queryResults.get('records')
        for record in records:
            resource = record.get('CreatedBy').get('Name')
            createDate = formatDate(record.get('CreatedDate'))
            amount = record.get('Amount')
        
        events.append([ record.get('Id'),'Create Opportunity', createDate, resource, '0' if 'null' == amount else amount, record.get('StageName') ])
        
        if queryResults.get('nextRecordsUrl') != None :
            importOpportunityCreation(accessToken, instanceUrl, events, queryResults.get('nextRecordsUrl'))

    # retrieve data for opportunity change
    def importOpportunityChange(accessToken, instanceUrl, events, nextRecordsUrl=None):
        
        queryResults = runSOQLQuery('Select OpportunityId, CreatedBy.Name, CreatedDate,' + ' Field, NewValue, OldValue from OpportunityFieldHistory', accessToken, instanceUrl, nextRecordsUrl)

        records = queryResults.get('records')
        for record in records:
            resource = record.get('CreatedBy').get('Name')
            opportunityId = record.get('OpportunityId')
            createDate = formatDate(record.get('CreatedDate'))
            field = record.get('Field')
            
            if 'StageName' == field:
                activity='Set Opportunity to ' + record.get('NewValue')
            elif 'Owner' == field:
                activity='Change opportunity Owner'
            elif 'AccountId' == field:
                activity = 'Change opportunity Account'
            elif 'Amount' == field:
                activity= 'Change opportunity Amount'
            
            events.append([ opportunityId, activity, createDate, resource, 0, ‘’ ])
 
        if queryResults.get('nextRecordsUrl') != None :
            importOpportunityChange(accessToken, instanceUrl, events,
                queryResults.get('nextRecordsUrl'))

スクリプトを作成し、 Python ファイル（.py ファイル）をシステムに保存したら、[ Upload your Process App logic ]ステップの[ Drag and drop file here to click to upload] リンクをクリックし、[ Custom process app] ウィザードで Python ファイルを選択してアップロードします。

Python ファイルのアップロードが完了したら、 [次へ] ボタンをクリックして、 カスタムプロセスアプリウィザードの [ ユーザー入力の定義 ] ステップに進みます。

「ユーザー入力の定義」 ステップでは、Process App ユーザーがプロセス生成中に変換するデータを指定するために使用する必要がある入力データ・フィールドをセットアップします。 このステップはオプションです。 ユーザー入力の定義ステップの詳細については、 ユーザー入力フィールドの定義を参照してください。

「次へ」 ボタンをクリックして、 「ユーザー・ガイダンスの提供」 ステップに進みます。

「ユーザー・ガイドの提供」 ステップでは、カスタム Process App のユーザー・ガイドを作成します。 このステップはオプションです。 ユーザーガイダンスの提供ステップの詳細については、 プロセスアプリのユーザーガイダンスの提供を参照してください。

「次へ」 ボタンをクリックして、 「プロセス設定」 ステップに進みます。

「プロセス設定」 ステップは、Process App 作成の最後のステップです。 このステップでは、 .idp 形式のプロセス・バックアップ・ファイルをアップロードするか、既存のプロセスから設定を複製して IBM Process Mining. Process App は、マップされたデータ列、プロセス設定、フィルター、およびプロセス・バックアップ・ファイルのダッシュボードを使用して、新規プロセスを生成します。

プロセス・バック・ファイルをアップロードするには、以下の手順に従います：

1. 「プロセス設定」 ステップで 「プロセス・バックアップ・ファイルのアップロード」 オプションを選択します。

2. プロセス・バックアップ・ファイルをアップロードするには、 「ファイルをここにドラッグ・アンド・ドロップするか、クリックしてアップロードします」 リンクをクリックします。

3. 「保存」ボタンをクリックします。

既存のプロセスの設定を複製するには、以下の手順を実行します。

1. 「プロセス設定」 ステップで 「プロセスから設定を複製」 オプションを選択します。

2. 「プロセスの検索」 ドロップダウンからプロセスを選択します。

3. 「作成」 ボタンをクリックします。

プロセス・バックアップ・ファイルがない場合は、抽出された列 ( opportunityId、 activity、 startTime、 resource、 opportunityAmount、および opportunityStage) を使用して .csv ファイルを作成できます。 .csv 。 IBM Process Mining で、 .idp 形式のバックアップ・ファイルを作成することができる。