このエントリーをはてなブックマークに追加

【UiPath 開発者向け】美しいロボットの作り方 -番外編-
サボると逆に面倒!?開発ルールの決め方

RPA開発者の皆さんお疲れ様です。
皆さん、美しいロボットは作れていますか?

プログラミングにおけるいわゆる美しいとは、ソースコードの書き方が統一されていて他の人が保守しやすいように整理されていることを指します。さて、RPAにおける「美しい」ロボットとは何でしょうか?
アクティビティ数が少ない、処理が速い、止まりにくい、他部署へ展開しやすい…。いろいろな観点がありますが、ここでは「見やすさ」という点に注目したいと思います。
「見やすさ」というのは保守のしやすさや、他の人が理解しやすいことを指します。
ロボットの引継ぎや自作のロボットを久しぶりに見たとき、処理が見やすいと理解や説明にかかる時間を短くすることができます。

本コラムでは弊社研修でよく質問されることを中心に、美しいロボット作成のヒントをご紹介していきます。
前回は[繰り返し(コレクションの各要素)]の使いどころについてご紹介しました。
>>【UiPath 開発者向け】美しいロボットの作り方vol.05~知ってると便利![ワークフローファイルの呼び出し]アクティビティ~

開発ルールはなぜあるの?

今回は番外編、ロボットを開発するにあたりあらかじめ決めておくべき開発ルールについてご紹介します。
開発ルールは開発標準とも呼ばれ、大規模なプログラミング開発をするときに他の開発者と共通の認識をもってプロジェクトを進める手助けになります。
RPAも最初は小さなロボットから作り始めますが、長く運用すると複数の部署にまたがる大規模なロボットや別の人が作ったロボットの保守や修正をする機会が増えていきます。開発ルールを作って誰がどのロボットを見ても内容が分かりやすくすることをお勧めします。
開発ルールを決めておくと以下のようなメリットがあります。

「命名規則を設定する」



命名規則がない場合(左)とある場合(右)


命名規則は、変数名やロボット名を付けるときの一定のルールのことです。開発時にルールを守ることで後からロボットを確認する人が開発者と共通の認識をもってロボットを確認することができます。

まず【変数名】で守らなければならないのは「扱うデータにあった名前にする」という点です。例えば上の図にもあるように、適当な名前を付けてしまうと、あとあと見返したときにどういうデータを使っていたのか読み解くのが大変になります。一目見て内容が分かりやすい名前を付けることで誰が見ても解読しやすいロボットに近づけます。

次に【アクティビティ名】の場合は、「一意であること」を定めることが多いです。一意とは、他と被ることがないことを指します。(ユニークとも言います。)アクティビティ名はエラーが発生したときにログ情報として残ります。同じアクティビティ名を複数使用している場合は、エラー発生個所の特定に時間がかかってしまいます。しかしアクティビティ名を一意のものにしていると、エラー発生個所の特定がスムーズにできます。

UiPathの新規プロセス作成画面


最後に、【ロボット名】の命名規則は、運用管理をするときに役立ちます。運用しているロボットの数が増えてくると名前のかぶりが出てきたり、管理が大変になります。そこで「先頭に部署名を付ける」「連番を入れる」など一括管理するときに便利な情報を入れておくと、ロボットの管理・把握に生かすことができます。

「アクティビティには必ず注釈を記載する」



UiPathには「注釈」という、処理に対するコメント機能があります。自分が作成したロボットでも開発から時間が空いてしまうと細かい処理を忘れてしまいます。そのため、アクティビティごとにこまめに注釈を入れることで、どんな処理をしているのかパッと文章で理解することができます。これはロボットを他の人に引き継ぐときにも便利です。

「変数のスコープは適切に設定する」



スコープを一か所に設定した場合(左)と、適切に設定した場合(右)


変数のスコープとは、その変数が使える有効範囲を設定する項目です。短いロボットであれば、変数をすべて確認できるように、一番広い範囲のスコープに設定していても問題ありません。しかし、比較的大きな処理のロボットを作成する場合は、たくさんの変数を作成することになり見づらくなります。スコープを適切に設定することで、今見ている処理でどの変数を使っているのか分かりやすくなります。

まとめ

今回ご紹介した開発ルールは、まったく守らなくてもロボットを作ることはできます。
ですが、RPAを長く運用していくと「こう決めておけばよかった!」と思うことがたくさん出てきます。
最初は面倒で、たくさんルールを作ると覚えるのも大変かもしれませんが、それぞれの職場にあったルールを作り、正しく守って組織的なRPA浸透を目指しましょう。

次回は、知っていると便利な[フロースイッチ]についてご紹介します。



supported by RPA HACK

このエントリーをはてなブックマークに追加

あわせて読みたい