Xplenty入門 Part6: ブラックボックス化しないための仕組み

ETLはどの製品もシンプルなGUIで簡単にパイプラインの構築ができることをを売りにしています。
しかし、作るときはシンプルでも、後々変更したりする際に、以下のような疑問を持ったことは誰しもあるかと思います。

• この処理は何を意図した処理なのか？
• この処理自体が不要では？

過去に自身で作ったものであっても背景や理由を思い出せず、それをトレースするのに時間がかかった苦い経験をお持ちの方は多いのではないでしょうか？
とはいえ自身で作成したものであればまだなんとか対応できたとしても、人が作ったものはドキュメントがないと、解読が難しいのも事実です。しかも、ドキュメントが必ずしも最新ではなく、結局１つ１つの処理を紐解いて確認していかないといけなかった経験のある方は多いのではないでしょうか？

Xplentyでは、こうした問題を解決するための機能として、パイプラインに仕様や注意事項などを直接埋め込むことができるコメント機能があります。この機能により、担当者が退職したためETLパイプラインがブラックボックス化してしまう悲劇を防ぐことができます。

Xplentyのコメント機能はパッケージ編集画面の好きな位置に置くことができ、より直接的にパイプラインの特定の箇所に説明を追加することが可能です。
例）

上記の例は簡単なコメントですが、コメントの編集画面では、さらに文字数を使って説明を詳細に記入することも可能です。

Xplentyでパッケージを作成する際は、ぜひこの機能をフル活用し、メンテナンス時に優しい仕組みを心がけてください。