開発ツールの連携でエラーが起きる原因｜ソースコード管理や通知、APIの上限まで確認手順を解説

開発ツールの連携で起こるエラーの種類

連携の不具合は「つながらない」とまとめられがちですが、症状によって確認する箇所は変わります。まず、起こりやすいエラーを分類しておくと、切り分けの出発点を決めやすくなります。

■認証に関わるエラー

接続に使う鍵や許可の期限が切れ、相手側から拒否される状態

■受け渡しに関わるエラー

接続はできるが、項目の不一致や上限への到達でデータが渡らない状態

■反映の遅れ

処理は進んでいるが、画面へ出るまでに時間差が生じている状態

認証に関わるエラー

外部サービスとの接続には、権限を与えるための鍵や許可の情報を使います。これらには有効期限が設定されている場合があり、期限が過ぎると連携が止まります。設定した本人が異動や退職でアカウントを失った際に、その人の権限で動いていた連携が停止することもあります。

対策としては、個人のアカウントではなく管理用のアカウントで接続を設定する方法があります。有効期限の日付を記録し、更新の時期を担当者間で共有しておきましょう。期限が近づいた際に通知が届く仕組みを用意できるかも、製品を選ぶ際の確認項目です。

データの受け渡しに関わるエラー

接続はできていても、渡すデータの形式が想定と違うと処理が失敗します。項目の名称が変更された、必須の項目が空のまま送られた、扱える文字数の上限を超えたといった状況が要因になります。相手側のサービスが仕様を更新した際に生じることもあります。

失敗した処理がどこに記録されるかを、導入の段階で確かめておきましょう。記録が残っていれば、どの項目でつまずいたかを追えます。記録が一定期間で消える製品もあるため、保存される期間と書き出しの可否もあわせて確認しておくことをおすすめします。

ソースコード管理との連携で起こる不具合

Gitに代表されるソースコード管理の仕組みと開発ツールをつなぐと、変更の記録と課題を結び付けられます。この連携では、結び付けの条件や接続の状態に関わる症状が起こる場合があります。

変更の記録が課題に結び付かない場合

変更の記録を課題へ結び付ける仕組みでは、記録に添えるコメントへ課題の番号を決められた形式で書く必要があります。形式が一致しないと、処理は失敗せずに結び付けだけが行われないため、気づきにくい症状です。

まずは書き方の決まりを確認し、チームで共有しておきましょう。番号の前に付ける記号や大文字と小文字の扱いは製品ごとに異なります。記述を補助する仕組みを使えるか、結び付いていない記録を一覧で確認できるかも、あわせて確かめておくと抜けを見つけやすくなります。

連携が途中で止まる場合

これまで動いていた連携が止まる場合、接続の設定が変更された、相手側のサービスで障害が発生した、通信を許可する範囲の設定が変わったといった要因が考えられます。自社側だけの問題とは限らないため、両方の状況を確認しましょう。

相手側のサービスが稼働の状況を公開している場合は、その情報を先に確認すると切り分けが早く進みます。社内の通信を制限している場合は、接続に必要な宛先が許可の対象に含まれているかを情報システム部門へ確認してください。設定を変更した履歴が残る運用にしておくと、原因の特定にかかる時間を短縮できます。

通知の連携で起こるエラー

チャットツールへの通知は、状況の共有を早める一方で、届かない場合や届きすぎる場合の両方が課題になります。ここでは通知に関わる2つの症状を取り上げます。

通知が届かないときの確認箇所

通知が届かない場合、開発ツール側の設定、通知の送信の記録、チャットツール側の受け取りの設定という3つの段階を順に確認します。どの段階で止まっているかによって、対応する担当者も変わります。

開発ツール側で通知の対象となる出来事が選ばれているか、送信先の宛先が正しいかをまず確かめましょう。送信の記録に成功と残っていれば、受け取り側の設定を確認する流れになります。チャットツール側でチャンネルの名称が変わった場合や、接続を許可する設定が外れた場合も、通知が届かない要因になります。

通知が過剰に届くときの調整

通知の対象を広く設定すると、件数が増えて重要な内容が埋もれる場合があります。読み飛ばす習慣がついてしまうと、通知の仕組み自体が役に立たなくなります。対象を絞り込む設計が必要です。

調整の方法としては、通知する出来事を状態の変更と担当の割り当てに限る、プロジェクトごとに送信先を分ける、優先度の高い課題だけを対象にするといった手立てがあります。設定の変更は運用の担当者だけで決めず、実際に受け取るメンバーの意見を聞いて調整すると定着しやすくなります。

ITトレンドでは、最新の製品・サービスを多数比較・掲載しています。まず資料を取り寄せて機能や特徴をさまざまな製品で比較してみてください。忙しい業務時間内でも、各社に問い合わせる手間なく、たった1回の入力（約60秒）で開発ツールの一括資料請求が可能です。浮いた時間で、じっくりと製品を比較検討し進めましょう。

APIの上限と試験管理との連携

自動化を広げるほど、連携用の窓口であるAPIを使う回数が増えます。あわせて、試験の管理を別のツールで行っている場合は、結果の受け渡しに手作業が残ることもあります。

呼び出し回数の上限に達する状況

APIとは、他のシステムから開発ツールの情報を読み書きするための窓口です。多くの製品では、一定の時間内に呼び出せる回数の上限が定められています。上限に達すると、その時間帯の処理が受け付けられず、連携が一時的に止まる場合があります。

上限の値と、達した際の挙動を資料で確認しておきましょう。一定時間を空ければ再開できるのか、明示的に再実行する必要があるのかで、備えの内容が変わります。定期的な取得の間隔を延ばす、必要な項目だけを取得するといった調整で、呼び出しの回数を抑えられる場合もあります。

試験結果の確認に手作業が残る状況

試験の管理を別のツールで行っている場合、実行の結果を開発ツール側へ渡す仕組みが必要です。標準の連携が用意されていても、渡せる範囲が結果の合否までに限られ、失敗した内容の詳細は元のツールで確認する形になることがあります。

この状態でも運用は成り立ちますが、確認のために画面を行き来する手間が残ります。導入の前に、どの項目まで渡せるのか、画面から元のツールの該当箇所へ移動できるのかを確かめておきましょう。渡せる範囲が限られる場合は、確認の担当と手順を決めて運用に組み込んでおくと混乱を避けられます。

連携エラーに備えて用意する仕組み

連携の不具合をあらかじめ避け切ることは難しいものです。起きた際に早く気づき、元の状態へ戻せる備えがあるかどうかで影響の大きさが変わります。ここでは3つの備えを挙げます。

異常を検知して知らせる

連携が止まっても画面上は変化がないため、気づくまでに時間がかかる場合があります。処理が失敗した際に管理者へ通知が届く設定があるかを確認し、有効にしておきましょう。通知の宛先は個人ではなく、複数名が見られる場所にしておくと見落としを減らせます。

あわせて、一定時間データが届いていない状態を検知できるかも確かめておきます。失敗の通知が出ない形で止まる場合もあるため、届いているはずの情報が来ていないことに気づける仕組みがあると安心です。定期的に連携の状況を確認する担当と頻度も決めておきましょう。

止まった処理を再実行する

失敗した処理を後から実行し直せるかは、復旧にかかる時間を左右します。自動で再試行する仕組みがあるか、手動で対象を選んで実行できるかを確認しておきましょう。再実行によって同じデータが二重に登録されないかも、あわせて確かめておく必要があります。

再実行に対応していない場合は、手作業で補う手順を用意しておきます。どの範囲のデータが渡っていないかを特定する方法と、補う際の担当を決めておくと、復旧の作業が滞りません。手順は文書にまとめ、担当者が不在の日でも別の人が対応できる状態にしておきましょう。

責任の範囲を整理しておく

連携には自社、開発ツールの提供元、連携先のサービスという複数の関係者が関わります。不具合が起きた際にどこへ相談するかが決まっていないと、対応が滞ります。契約の段階で、支援を受けられる範囲を確かめておきましょう。

標準で用意されている連携と、自社で作り込んだ連携では、支援の範囲が異なる場合があります。自社で作り込んだ部分は、社内で対応するのか外部へ依頼するのかを先に決めておきます。相談の窓口と連絡の手段を一覧にしておくと、緊急時に迷わず動けます。

連携の設定を見直す際の開発ツール

つなぐ相手が増えるほど、設定の記録と切り分けの手順が重要になります。連携を含めて構成を検討したい製品を紹介します。

Magic xpa Application Platform

マジックソフトウェア・ジャパン株式会社

資料請求リストに追加

製品詳細ページへ ＞

製品・サービスのPOINT

1. 【クロスプラットフォーム】ワンソース・マルチデバイス
2. 基幹業務システムの運用基盤としてグローバルで40年の実績
3. 【超高速開発！】CやJavaの10倍の開発生産性

まとめ

開発ツールの連携で起こるエラーは、認証の期限切れ、データの形式の不一致、呼び出し回数の上限への到達など複数の要因が関わります。症状が出たら、自社側と連携先の双方の状況を確認して切り分けましょう。あわせて、異常を知らせる通知、止まった処理を再実行する手立て、相談先の整理という3つの備えを導入の段階で用意しておくと、業務への影響を抑えられます。連携の範囲を比べたい方は、資料請求から確認してみてください。