6. ユーザプログラムの開発¶

• ApplicationContextは、 intra-mart Accel Platform で提供されているAPI ApplicationContextProvider にて取得可能です。

  public class ActionProcess extends ActionProcessEventListener {
  
     // 申請
     @Override
     public final String apply(final ActionProcessParameter parameter,
       final Map<String, Object> userParameter) throws Exception {
  
         // アクション処理用のサービスを取得します。
         final ActionProcessService service = ApplicationContextProvider.getApplicationContext().
                                            getBean(ActionProcessService.class);
         return service.apply(parameter, userParameter);
     }
  

  import org.springframework.transaction.annotation.Propagation;
  import org.springframework.transaction.annotation.Transactional;
  
  @Service
  @Transactional(propagation = Propagation.MANDATORY)
  public class ActionProcessServiceImpl implements ActionProcessService {
  
      @Inject
      SampleImwTPurchaseRepository repository;
  
      private final String PURCHASE_MATTER_PROPERTY_KEY = "item_total";
  
      // 申請
      public final String apply(final ActionProcessParameter parameter,
        final Map<String, Object> userParameter) throws Exception {
  
          System.out.println("----- ActionProcessParameter - apply -----");
          outputLog(parameter);
          System.out.println("----- ActionProcessParameter - apply -----");
  
          // サーバサイドバリデーションの実行
          validate(parameter, userParameter);
  
          // 案件番号の採番
          String number = null;
          try {
              number = WorkflowNumberingManager.getNumber();
          } catch (final WorkflowException e) {
              throw new WorkflowExternalException(
                MessageManager.getInstance().getMessage(
                   LocaleUtil.toLocale(parameter.getLocaleId()), "SAMPLE.IMW.ERR.003"));
          }
  
          // 入力データのテーブルへの登録
          SampleImwTPurchase entity = getEntity(parameter, userParameter);
          repository.insert(entity);
  
          // 入力データの案件プロパティへの登録
          createMatterProperty(
             parameter.getUserDataId(), PURCHASE_MATTER_PROPERTY_KEY, entity.getItemTotal());
          return number;
      }
  

• 具体的には、以下のユーザ操作がアクション処理のトリガーです。

• トリガーとなるユーザ操作ごとに呼び出されるメソッドが異なります。

  アクション処理 メソッド一覧

  処理種別	メソッド	説明
  申請	apply	標準申請画面にて「申請」ボタンを押下した際に呼び出されるメソッドです。
  再申請	reapply	標準処理画面にて、処理種別「再申請」を選択し、「処理」ボタンを押下した際に呼び出されるメソッドです。
  申請（一時保存）	applyFromTempSave	一時保存の状態で、標準申請画面にて「申請」ボタンを押下した際に呼び出されるメソッドです。
  申請（未処理）	applyFromUnapply	未申請の状態で、標準申請画面にて「申請」ボタンを押下した際に呼び出されるメソッドです。
  取止め	discontinue	標準処理画面にて、処理種別「取止め」を選択し、「処理」ボタンを押下した際に呼び出されるメソッドです。
  引戻し	pullBack	処理済み一覧で「引戻し」ボタンを押下した際に表示される標準画面にて、「引戻し」ボタンを押下した際に呼び出されるメソッドです。 ユーザコンテンツ画面での操作を経由しないため、UserParameterはnullです。
  差戻し後引戻し	sendBackToPullBack	差戻しされた状態にて、処理済み一覧で「引戻し」ボタンを押下した際に表示される標準画面にて、「引戻し」ボタンを押下した際に呼び出されるメソッドです。 ユーザコンテンツ画面での操作を経由しないため、UserParameterはnullです。
  承認	approve	標準処理画面にて、処理種別「承認」を選択し、「処理」ボタンを押下した際に呼び出されるメソッドです。 自動処理による承認の場合、ユーザコンテンツ画面での操作を経由しないため、UserParameterはnullです。 一括処理による承認の場合、ユーザコンテンツ画面での操作を経由しないため、UserParameterは空のMapです。
  承認終了	approveEnd	標準処理画面にて、処理種別「承認終了」を選択し、「処理」ボタンを押下した際に呼び出されるメソッドです。
  否認	deny	標準処理画面にて、処理種別「否認」を選択し、「処理」ボタンを押下した際に呼び出されるメソッドです。 自動処理による否認の場合、ユーザコンテンツ画面での操作を経由しないため、UserParameterはnullです。
  差戻し	sendBack	標準処理画面にて、処理種別「差戻し」を選択し、「処理」ボタンを押下した際に呼び出されるメソッドです。 自動処理による差戻しの場合、ユーザコンテンツ画面での操作を経由しないため、UserParameterはnullです。
  保留	reserve	標準処理画面にて、処理種別「保留」を選択し、「処理」ボタンを押下した際に呼び出されるメソッドです。
  保留解除	reserveCancel	標準処理画面にて、処理種別「保留解除」を選択し、「処理」ボタンを押下した際に呼び出されるメソッドです。
  案件操作	matterHandle	案件操作画面にてノード移動を行った際に呼び出されるメソッドです。 ユーザコンテンツ画面での操作を経由しないため、UserParameterはnullです。
  一時保存（新規登録）	tempSaveCreate	標準画面にて「一時保存」ボタンを押下した際に呼び出されるメソッドです。
  一時保存（更新）	tempSaveUpdate	一時保存の状態で、標準画面にて「一時保存」ボタンを押下した際に呼び出されるメソッドです。
  一時保存（削除）	tempSaveDelete	一時保存一覧画面にて、一時保存データに対する「削除」ボタンを押下した際に呼び出されるメソッドです。 ユーザコンテンツ画面での操作を経由しないため、UserParameterはnullです。

• アクション処理は標準申請・処理画面からのHTTPリクエストと同期的に実行されます。処理結果のメッセージを標準申請・処理画面に表示することが可能です。

  ただし、Controllerクラスとして呼び出される訳ではないので、Spring MVCの機能は利用できません。

• 標準画面の処理の非同期

  ワークフローパラメータのstandard-exec-jssp-asyncをtrueに変更した場合は、アクション処理はHTTPリクエストと非同期で実行されます。

  コラム

  standard-exec-jssp-asyncの仕様については、 「 IM-Workflow 仕様書 」-「3.22 標準画面の処理の非同期」を参照してください。

• アクション処理は IM-Workflow エンジン側が張るトランザクションの内部で呼び出されるため、データの一貫性を保証する必要がある処理です。 @Transactionalアノテーション を付与してトランザクションの管理を行う必要があります。

• アクション処理内でシェアードデータベースへの更新処理を行うことはできません。

  IM-Workflow エンジンがテナントデータベースへトランザクションを張っている、かつ intra-mart Accel Platform ではXAトランザクションが利用できないため。

• WorkflowExternalException をスローすることで、指定したメッセージを画面に表示することが可能です。

  メッセージIDではなく、メッセージ本文にて指定します。

  throw new WorkflowExternalException(
       MessageManager.getInstance().getMessage(
          LocaleUtil.toLocale(parameter.getLocaleId()), "SAMPLE.IMW.ERR.003"));
  

• 標準申請・処理画面からのHTTPリクエストとは非同期で実行されます。

  到達処理では、HTTPリクエスト・セッションの情報を参照することはできません。

• 同期／非同期制御

  ワークフローパラメータのarrive-process-asyncをfalseに変更した場合は、到達処理はHTTPリクエストと同期的に実行されます。

  コラム

  arrive-process-asyncの仕様については、 「 IM-Workflow 仕様書 」-「5.1.1.1.1 案件終了処理、到達処理、メール送信処理、IMBox 送信処理の同期／非同期制御の設定」を参照してください。

• 到達処理が実行されるタイミングでは IM-Workflow エンジンによるトランザクションが確定しているため、独自にトランザクション制御を行う必要があります。

  通常は、データベースへの更新処理を行うメソッドに対して、@Transactionalアノテーション を付加します。

  public class ArriveProcess extends ArriveProcessEventListener {
  
     public ArriveProcess() {
         super();
     }
  
     public boolean execute(final ArriveProcessParameter parameter) throws Exception {
        // 到達処理用のサービスを取得します。
        final ArriveProcessService service = ApplicationContextProvider.getApplicationContext().
                                           getBean(ArriveProcessService.class);
        service.execute(parameter);
     }
  

  import org.springframework.transaction.annotation.Transactional;
  
  @Service
  public class ArriveProcessServiceImpl implements ArriveProcessService {
  
      @Inject
      ExternalDatabaseRepository repository;
  
      @Override
      @Transactional(rollbackFor=java.lang.Exception.class)
      public boolean execute(
          final ArriveProcessParameter parameter) throws Exception {
          SampleImwTPurchase entity = repository.insert(parameter.getUserDataId());
          return true;
      }
  }
  

• 標準申請・処理画面からのHTTPリクエストとは非同期で実行されます。

  案件終了処理・案件終了処理（トランザクションなし）では、HTTPリクエスト・セッションの情報を参照することはできません。

• 直前のアクション処理や到達処理とは独立した処理となるため、案件終了処理・案件終了処理（トランザクションなし）でエラーが発生した場合、直前の処理を戻す（ロールバック）することはできません。
• 案件終了処理（トランザクションなし）は、案件終了処理の前に実行され、独自にトランザクション制御を行う必要があります。
• 案件終了処理は IM-Workflow エンジン側が張るトランザクションの内部で呼び出されるあめ、データの一貫性を保証する必要がある処理です。 @Transactionalアノテーション を付与してトランザクションの管理を行う必要があります。

• Exceptionクラスをスローすることで、案件終了処理・案件終了処理（トランザクションなし）をエラーとすることが可能です。

  • 案件終了処理（トランザクションなし）

    ユーザプログラム側でトランザクション制御を行うため、エラー時にはユーザプログラム側でロールバックを行ってください。

  • 案件終了処理

    IM-Workflow エンジンの内部処理にてトランザクションを管理しているため、エラー時にユーザプログラム側でロールバックを行わないでください。

• 案件終了処理・案件終了処理（トランザクションなし）がエラーとなった場合は、案件が完了せず、終了ノードで停止した状態に変化します。