WIPO Sequence Validatorの操作マニュアル

ステップ3：テスト

Validator サービスのテストは、 postman を使用して次の手順で実行できます。

• postman アプリケーションを開き、新しいリクエストを作成します
• リクエスト本体の情報を追加します：
• Sendをクリックすると、次のような応答が得られます。

３．リクエスト

コールバックエンドポイントリクエスト

検証リクエストの終了後、WIPO Sequence Validatorは、コールバックエンドポイントへのリクエストに必要なパラメータを含むJSONファイルを生成します。このリクエストは、ファイルの場所と検証プロセスの詳細を示す次のパラメータを含みます。

{ "currentApplicationNumber": "string", "currentSEQLVersionNumber": "string", "patentApplicationNumber": "string", "seqlInputLocation": "string", "verificationReportOutputPath": "C:/temp/st26/reports/", "nameFile": "valid2Warning.xml", "type": "FULL" }

検証リクエストの“seqlInputLocation”フィールドを、検証するXML配列表のパスを示すように設定する必要があります。知的財産庁がこのフィールドを空のままにした場合、ツールは、デフォルトの[未処理]フォルダにあるファイル名「nameFile」のXMLファイルを検証しようとします。「nameFile」パラメータで、検証する配列表ファイルを識別します。

リクエスト内の“verificationReportOutputPath”は、ツールによって作成された検証レポート（.xml）のファイルの場所を示します。ユーザーがこのフィールドを空白のままにしたり、無効なファイルパスを入力した場合、検証レポートはデフォルトの[レポート]フォルダに保存されます。

プロパティ「api.URL」が設定されている場合、Validatorは、指定されたURLのエンドポイントに検証結果を送信しようとします。

Validatorと通信するには、コールバックエンドポイントがこのWebサービス契約（YAML）に準拠していなければなりません。

さらに、リクエストは次の構造を持つJSONオブジェクトである必要があります。

{ "currentApplicationNumber": "string", "currentSEQLVersionNumber": "string", "elapsedTime": 0, "endTime": "string", "errorSummary": [ { "dataElement": "string", "detectedSequence": "string", "index": 0, "key": "string", "locmessage": "string", "params": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "paramsForXML": [ { "key": "string", "value": "string" } ], "reportValue": "string", "sequenceIDNumber": "string", "type": "string" } ], "httpStatus": "string", "parentApplicationNumber": "string", "parentSEQLVersionNumber": "string", "processID": "string", "seqIDQuantity": 0, "seqInputQuantity": 0, "seqlType": "string", "startTime": "string", "totalErrorQuantity": 0, "totalWarningQuantity": 0, "verificationReportOutputPath": "string"

これは、Validatorに呼び出しを行った外部エンドポイントに送信されるJSONインスタンスの例です。

{ "processID": "1608194222169dvVE", "seqlType": "ST.26", "httpStatus": "SUCCESS", "currentApplicationNumber": "string", "currentSEQLVersionNumber": "string", "parentApplicationNumber": "string", "parentSEQLVersionNumber": "string", "verificationReportOutputPath": "C:/temp/report.xml", "startTime": "2020-12-17 09:36:54.000000", "endTime": "2020-12-17 09:37:26.000607", "elapsedTime": 32607, "totalWarningQuantity": 1, "totalErrorQuantity": 2, "seqInputQuantity": 3, "seqIDQuantity": 3, "errorSummary": [ { "index": 0, "reportValue": "", "type": "WARNING", "params":com.wipo.st26.ipotool.models.ServiceRequest@5887858, "key": "X_EARLIEST_PRIO_APPLICATION_ID_MISSING", "locmessage": "Earliest priority application information is absent. It must be provided when a priority claim is made to an earlier application.", "detectedSequence": "", "dataElement": "PROPERTY_NAMES.EARLIEST_PRIORITY_APPLICATION" }, { "index": 0, "reportValue": "-", "type": "ERROR", "params": {}, "key": "INVENTION_TITLE_MISSING", "locmessage": "The invention title is missing. At least one invention title must be entered.", "detectedSequence": "", "dataElement": "PROPERTY_NAMES.INVENTION_TITLE_BAG" }, { "index": 1, "reportValue": "-", "type": "ERROR", "params": {}, "key": "INVENTION_TITLE_MISSING", "locmessage": "The invention title is missing. At least one invention title must be entered.", "detectedSequence": "", "dataElement": "PROPERTY_NAMES.INVENTION_TITLE_BAG" } ] }

４．レポート

検証レポート

WIPO Sequenceによって生成される検証レポートはXML形式であり、必要に応じて、WIPO Sequenceで使用されているものと同じスタイルシートを使用したHTML形式も可能です。ルートレベルで示される属性は：

• 'applicationNumberText'：この配列表に関連付けられたアプリケーション
• 'productionDate'：検証が行われた日付
• 'filingDate'：出願日
• 'softwareBuildVersion'：検証に使用されるValidatorのバージョン
• 'softwareVersion'：配列表の作成に使用されるWIPO Sequenceのバージョン
• 'sourceFileName'：配列表XMLインスタンスの名称

検証レポートの作成に使用されるテンプレート (XSD) ：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <VerificationReport productionDate="YYYY-MM-DD" sourceFileName="[ST.26 filename]"> <VerificationMessageBag> <VerificationMessage> <Severity>[ERROR | WARN | XML_WARN | XML_ERROR]</Severity> <DataElement>[ST.26 element]</DataElement> <DetectedSequence>[Sequence ID]</DetectedSequence> <DetectedValue>[value]</DetectedValue> <MessageKey>[Message key]</MessageKey> <ParameterBag> <Parameter key="param key">Param value</Parameter> <ParameterBag> <LocalizedMessage> [Localized message] </LocalizedMessage> </VerificationMessage> ... </VerificationMessageBag> </VerificationReport>

示された重大度に関しては、以下の分類に留意してください。

• ERROR - 「完全」検証中に返されるエラー
• WARNING - 「完全」検証中に返される警告
• XML_ERROR - 「形式」検証中に返されるエラー
• XML_WARN - 「形式」検証中に返される警告

検証後、いずれか一方、または両方の形式で生成された検証レポートは、verificationReportOutputPathにあり、デフォルトでは以下の場所にあります：

./temp/st26/reports/[verificationID]/

XML 形式の検証レポートの例は、以下の 関連情報 に記載されています。

５．設定

デフォルト設定

Validatorは、プロパティファイルを使用して設定されます。デフォルトの値は、*公開されたapplication.ymlにあります。

ここで示したパラメータの値を変更するには、代替のapplication.ymlファイルを使用してください。Spring Bootのドキュメンテーションに詳述されているように、いくつかのオプションがあります

また、設定ファイルのパスおよび名前は、ツールの起動時にコマンドラインにパラメータを設定することによって指定できます。

• JARデプロイの場合：

  java  -jar -Dspring.config.location=<PATH_TO_FILE>  wipo-sequence-validator.jar

• TomcatでのWARデプロイの場合は、CATALINA_OPTSに次のエントリを追加する必要があります。
  • Windows:

    set SPRING_CONFIG_ADDITIONAL-LOCATION=-Dspring.config.location=<PATH_TO_FILE>

  • Linux :

    export SPRING_CONFIG_ADDITIONAL-LOCATION="-Dspring.config.location=<PATH_TO_FILE>

WARデプロイを使用する場合、新しいapplication.ymlファイルをウェブアプリケーションの[WEB-INF/classes]フォルダにコピーすることもできます。

application.ymlファイルでは、HTML レポートの作成を有効または無効にすることができます。値を[true]に設定することでレポート作成を有効にし、値を[false]に設定することで無効にします。このレポートの内容は、ServiceRequestのerrorSummaryフィールド内のコールバックエンドポイントに送信されます。

検証ルールVXQV_49

ユーザーがルールVXQV_49を有効にしたい場合は、optionalEnglishQualifierValueの値を[true]に設定し、optionalRuleTypeの値をERRORまたはWARNINGに更新することで、ルールの重大度を設定できます。

Healthpoint （正常性）

Validator は、アプリケーションの正常性に関する基本情報を提供する /health エンドポイントを実装しています。healthエンドポイントを調べるには、次の URL を開いて下さい

http://localhost:8080/wipo-sequence-validator/actuator/health

エンドポイントには、次の情報が表示されます。

• アプリケーションが正常であれば、ステータスはUPです。
• データベースとの接続やディスク容量の不足などの問題によりアプリケーションに問題が生じると、DOWNと表示されます。

health エンドポイントは、単純なUPまたはDOWNステータスのみを表示します。application.yml ファイルの次のプロパティは、正常性チェックプロセスの一部としてチェックされた全ての正常性インジケータのステータスを含む、全ての詳細を提供します。

health エンドポイントに、正常性チェックプロセスの一部として実行されるDiskSpaceHealthIndicatorの詳細が含まれるようになりました。

health エンドポイントは以下のように表示されます

ローカライズされたメッセージ

Validatorは、例えば検証レポートで、PCTの公式の10の言語（アラビア語、中国語、英語、フランス語、ドイツ語、ポルトガル語、日本語、韓国語、ロシア語、スペイン語）にローカライズされたメッセージを提示することができます。

デフォルトでは、メッセージは英語で提示されます。メッセージを他の言語で提示するようにValidatorを設定するには、application.yml ファイルのvalidator_localeパラメータを適切な言語コードに設定してください。

ユーザー生物名

知的財産庁は、既定の初期生物名リストに含まれない独自のユーザー生物名を含むために、custom_organism.jsonという名前の新しいファイルを[alternativeResourceBasePath]フォルダ内に作成することによってユーザー生物のリストを提供することができます。このファイルは、次の構造である必要があります。

他のDTDバージョン

デフォルトでは、Validatorは、最新バージョンの ST.26 DTD を参照します。WIPO Sequence Validatorの現在のバージョンは、WIPO ST.26 DTDのバージョン1.3に基づいています。ST.26 DTDの最新バージョンのコピーは、ソースコードの[/src/main/resources]フォルダにあるValidatorライブラリに含まれています（これはJARまたはWARファイル内で参照される定義されたファイルパスです）。これは、次に示すように、同じフォルダ内の「catalog.xml」ファイルで参照されています。

検証時には、XMLファイルのDOCTYPE宣言で設定されたDTDのバージョンが使用されます。まず、使用するDTDファイルの場所を識別するために、「publicId」が使用されます。「publicId」がカタログに含まれていない場合、システムは、Javaプロセスが実行されているルートフォルダ内のDTDファイルの検索を試みます。

古いバージョンのST.26 DTDを参照するWIPO ST.26ファイルを検証できるようにするには、このST.26 DTDファイルをValidatorで使用できるようにして、適切な検証を可能にする必要があります。 これを実行するには、2つの代替アプローチがあります。

1. JARファイルを解凍し、追加または代替ST.26 DTDファイルへの参照を[src/main/resources]フォルダに含めます。“catalog.xml”ファイルを変更し、追加のST.26 DTDの新しいエントリを追加するか、既存のエントリを編集します。 以下はその例です。

1. JARファイルを変更する代わりに、次の手順に従う必要があります：
   (i)catalog.xmlおよびすべてのDTDをローカルフォルダにコピーします；
   (ii)そして、catalog.xmlを調整し、追加のST.26 DTDへの参照を含めます；そのうえで、
   (iii)起動時に次のJavaシステムプロパティを設定します： xml.catalog.files=<path_to_catalog.xml>

Windows用のTomcatでは、次の環境変数を追加することによって行うことができます：

６．関連情報

以下の関連情報を、知的財産庁において適宜参照してください。

• Example verification report
• Complete API specification, YAML
• Property Names, JSON