intra-mart Accel Platform API Documentation

intra-mart accelerates your business.

はじめに

1. 注意事項

このAPIドキュメントでは、intra-mart Accel Platform におけるモジュール構成、およびプログラム・インターフェースであるAPI仕様について解説しています。
このAPIドキュメントに記載されている内容は、株式会社NTTデータイントラマートで定めた intra-mart Accel Platform における公式なAPI仕様になります。
このAPIドキュメント内に記載されていない内容に関しては保証致しかねますので、予めご了承ください。

Client Side JavaScript API(IWP v7.2) に記載されている内容は、 intra-mart ® 7.2 patch08 Client Side JavaScript におけるAPI仕様になります。
intra-mart Accel Platform において非推奨となったAPIおよび削除となったAPIの情報は、互換対応表で確認できます。

2. 「バージョン(@version)」、「導入されたバージョン(@since)」の表記について

各APIにおいて、「バージョン(@version)」、「導入されたバージョン(@since)」の説明があります。各定義は次の通りです。

@version = 更新されている最新のバージョン
@since = 導入されたバージョン

また、製品によって表記方法が異なります。
  • BaseModule,WebPlatformから提供されているAPIのバージョン表記方法
  •    表記定義:製品バージョン(例:WebPlatform Version 7.2 の「7.2」)
       バージョン範囲:バージョン「1」~「7.2」
       ※Accel Platform から仕様変更となった場合、@version は「8.x.x」となります。

  • Accel Platformから提供されているAPIのバージョン表記方法
  •    表記定義:各モジュールのバージョン(例:im_tenant モジュール 8.0.1の「8.0.1」)
       バージョン範囲:バージョン「8.0.0」~

    Accel Platform製品においては、上記の製品で提供されたAPIが混在しているため、各APIにより表記方法が異なります。
    上記の”バージョン範囲”をご参考頂き、製品バージョン、もしくは、モジュールバージョンなのかをご判断ください。

    1. 注意事項

    ここで記載している予約語は、JavaScript で定義されているもの、および JAVA で定義されているものの他に、intra-mart で定義しているものを含みます。
    定義されている予約語は、プレゼンテーションページ、ファンクションコンテナのどちらのプログラム内においても守る必要があります。
    (ブラウザ上で動作をする Client Side JavaScript のプログラム内においても適用されます。)

    予約語適応例
    • JavaScript 変数名
    • JavaScript 関数名
    • JavaScript 共通関数定義名(Procedure)
    • URL引数のキー名称
    • HTMLフォームのコントロール名称
    • HTMLフォーム名(name 属性)
    • HTMLスタイルシート名
    • HTMLレイヤー名
    • JAVA パッケージ名
    • intra-mart デプロイ先のファイル名称
    • intra-mart デプロイ先のディレクトリ名称
    • データベース表名
    これらの名前付けにおいて予約語に違反した命名をした場合、intra-mart の動作が不安定になったり、intra-mart の アップデート時にスムーズな対応ができない場合があります。

    2. スクリプト開発モデル予約語

    2.1. JavaScript
    一般的なJavaScript(Client Side JavaScriptも含む)の予約語
    abstractbooleanbreakbytecasecatchcharclassconstcontinuedefaultdodoubleelseextendsfalsefinalfinallyfloatforfunctiongotoif
    implementsimportininstanceofintinterfacelongnativenewnullpackageprivateprotectedpublicreturnshortstaticsuperswitchsynchronized
    thisthrowthrowstransienttruetrytypeofvarvoidwhilewith
    2.2. グローバル変数
    Client.set()メソッドのキーとして使用している文字列
    bx3m52nmcgl00(Identifier.get()で取得した値)USERatr_cfg_modeatr_cfg_gIdchannel_cfg_modechannel_cfg_gIdsrh_cfg_gIdsrh_cfg_notDisplaysrh_cfg_style
    dbs_cfg_modedbs_cfg_gIdgrp_conf_userdatausr_cfg_gIdlnk_cfg_modelnk_cfg_gIdmsg_cfg_modemsg_cfg_gIdpag_cfg_gIdpag_ndp020rle_cfg_mode
    rle_cfg_gIdusr_cfg_modeusr_cfg_dbmusr_cfg_gIdzon_cfg_modezon_cfg_gIdSYSTEM.MENU.ACTIVE.IDALERTwkf_sortInfwkf_strDateFromwkf_strDateTo
    wkf_request_bkmmt_ndp131mmtData
    2.3. 共通関数
    Procedure.define()メソッドのキーとして使用している文字列
    agecriteriondatedateuploadsqlRealNumberworkflowwkf_isRoutewkf_isItemOnRoutewkf_insertRoutewkf_updateRoutewkf_deleteRoutewkf_getUserNote
    wkf_getCntAnalyzewkf_getAckDayTermAvgwkf_toNullStringwkf_getFullUserNamewkf_ackkind_func

    3. JavaEE開発モデル予約語

    3.1. Java
    一般的なJavaの予約語
    (JAVA の予約語の大部分は、JavaScript の予約語に含まれています。)
    abstractbooleanbreakbytecasecatchcharclassconstcontinuedefaultdodoubleelseextendsfinalfinallyfloatforgotoifimplementsimport
    instanceofintinterfacelongnativenewnullpackageprivateprotectedpublicreturnshortstaticsuperswitchsynchronizedthisthrowthrows
    transienttryvoidvolatilewhile
    3.2. グローバル変数
    jp.co.intra_mart.foundation.service.client.informationパッケージ中のIdentifierクラス以外のset()メソッド、entry()メソッドのキーとして使用している文字列
    bx3m52nmcgl00(Identifier.get()で取得した値)USERatr_cfg_modeatr_cfg_gIdchannel_cfg_modechannel_cfg_gIdsrh_cfg_gIdsrh_cfg_notDisplaysrh_cfg_style
    dbs_cfg_modedbs_cfg_gIdgrp_conf_userdatausr_cfg_gIdlnk_cfg_modelnk_cfg_gIdmsg_cfg_modemsg_cfg_gIdpag_cfg_gIdpag_ndp020rle_cfg_moderle_cfg_gId
    usr_cfg_modeusr_cfg_dbmusr_cfg_gIdzon_cfg_modezon_cfg_gIdSYSTEM.MENU.ACTIVE.IDALERTwkf_sortInfwkf_strDateFromwkf_strDateTowkf_request_bk
    mmt_ndp131mmtData

    4. intra-mart 予約語

    4.1. プレフィックス
    以下の文字、または文字列をプレフィックスとする語
    (また、APIで提供されているクラスおよび関数では大文字を接頭辞として使用しています。 )
    _imImiMIM
    4.2. フォルダ名
    Storageに使用しているフォルダ名
    basemodulesystem

    クライアントサイド JavaScript

    スクリプト開発モデル

    CSSモジュール一覧


    Back to top

    Copyright © 2012 NTT DATA INTRAMART CORPORATION