概要
今後、ServiceNow開発で利用することを検討しているリソースの命名規則です。まだ試している最中です。
全般
- 変数名及びキーは英数のみを利用。日本語は利用しない。
リソース
フォーム(スネークケース)
No. | 項目 | 値 | コメント |
---|---|---|---|
1 | チーム名 | infra_ | 他チームと区別するための ITIインフラ用の接頭辞。 |
2 | アプリケーション名 | アプリケーション接頭辞を参照 | 3文字以内にする |
3 | リソースタイプ | frm | 固定 |
4 | リソース名 | 例:updateDelete | キャメルケースを利用。スクリプトを行う内容を説明 |
例:
- infra_dns_frm_updateDelete
- infra_sub_frm_new
クライアント・スクリプト(スネークケース)
No. | 項目 | 値 | コメント |
---|---|---|---|
1 | チーム名 | infra_ | 他チームと区別するための ITIインフラ用の接頭辞。 |
2 | アプリケーション名 | アプリケーション接頭辞を参照 | 3文字以内にする |
3 | リソースタイプ | cs | 固定 |
4 | リソース名 | 例:checkDns | キャメルケースを利用。スクリプトを行う内容を説明 |
例:
- infra_dns_cs_initializeForm
- infra_dns_cs_checkDns
スクリプト・インクルード(キャメルケース)
No. | 項目 | 値 | コメント |
---|---|---|---|
1 | チーム名 | infra | 他チームと区別するための ITIインフラ用の接頭辞。 |
2 | アプリケーション名 | アプリケーション接頭辞を参照 | 3文字以内にする |
3 | リソースタイプ | si | 固定 |
4 | リソース名 | 例:checkDns | キャメルケースを利用。スクリプトを行う内容を説明 |
例:
- infraDnsSiInitializeForm
- infraDnsSiCheckDns
関数名(キャメルケース)
例:
- validateIp()
- validatePort()
フロー
No. | 項目 | 値 | コメント |
---|---|---|---|
1 | チーム名 | infra_ | 他チームと区別するための ITIインフラ用の接頭辞。 |
2 | アプリケーション名 | アプリケーション接頭辞を参照 | 3文字以内にする |
3 | リソースタイプ | flw | 固定 |
4 | リソース名 | 例:approval | キャメルケースを利用。スクリプトを行う内容を説明 |
例:
- infra_dns_flw_approval
フローディザイナー:アクション(スネークケース)
No. | 項目 | 値 | コメント |
---|---|---|---|
1 | チーム名 | infra_ | 他チームと区別するための ITIインフラ用の接頭辞。 |
2 | アプリケーション名 | アプリケーション接頭辞を参照 | 3文字以内にする |
3 | リソースタイプ | act | 固定 |
4 | リソース名 | 例:checkDnsExists | キャメルケースを利用。スクリプトを行う内容を説明 |
例:
- infra_dns_act_checkDnsExists
- infra_dns_act_updateDnsDomain
正規表現(スネークケース)
正規表現は共有リソースになりますのでアプリケーションは「common」(共有)にする。
No. | 項目 | 値 | コメント |
---|---|---|---|
1 | チーム名 | infra_ | 他チームと区別するための ITIインフラ用の接頭辞。 |
2 | アプリケーション名 | com | 3文字以内にする |
3 | リソースタイプ | reg | 固定 |
4 | リソース名 | 例:checkDns | キャメルケースを利用。スクリプトを行う内容を説明 |
例:
- infra_com_reg_checkDns
CIクラス/テーブル名(スネークケース)
カスタムのクラス名及びテーブル名は標準ServiceNowとの区別するために「u_」から始める。
No. | 項目 | 値 | コメント |
---|---|---|---|
1 | チーム名 | u_infra_ | ServiceNowの列名と他チームと区別するためのに ITIインフラ用の接頭辞は「u_infra」にする |
2 | 親テーブル | 親テーブルがある場合 | |
3 | テーブル名 | 例:internalDomain | キャメルケースを利用。スクリプトを行う内容を説明 |
例:
- u_infra_cmdb_ci_web_site_internalDomain
列名(スネークケース)
カスタムの列名は標準ServiceNowとの区別するために「u_」から始める。
No. | 項目 | 値 | コメント |
---|---|---|---|
1 | チーム名 | u_infra_ | ServiceNowの列名と他チームと区別するためのに ITIインフラ用の接頭辞は「u_infra」にする |
2 | 列名 | 例:checkDns | キャメルケースを利用。スクリプトを行う内容を説明 |
例:
- u_infra_domainName
レポート(スネークケース)
No. | 項目 | 値 | コメント |
---|---|---|---|
1 | チーム名 | infra_ | 他チームと区別するための ITIインフラ用の接頭辞。 |
2 | アプリケーション名 | アプリケーション接頭辞を参照 | 3文字以内にする |
3 | リソースタイプ | rpt | |
4 | リソース名 | 例:checkDns | キャメルケースを利用。スクリプトを行う内容を説明 |
例:
- infra_dns_rpt_dnsList
ロール(スネークケース)
ロールはServiceNowインスタンスで共有される。
No. | 項目 | 値 | コメント |
---|---|---|---|
1 | チーム名 | u_infra_ | 他チームと区別するための ITIインフラ用の接頭辞。 |
2 | ロール名 | 例:itiservice_admin |
例:
- infra_itiservice_admin
メッセージ・キー(スネークケース)
メッセージ・キーはアプリケーション間で共有しない。
カスタムのメッセージキーは標準ServiceNowとの区別するために「u_」から始める。
No. | 項目 | 値 | コメント |
---|---|---|---|
1 | チーム名 | u_infra_ | 他チームと区別するための ITIインフラ用の接頭辞。 |
2 | アプリケーション名 | アプリケーション接頭辞を参照 | 3文字以内にする |
3 | リソースタイプ | msg | |
4 | キー名 | 例:internalDomainName | キャメルケースを利用。スクリプトを行う内容を説明 |
例:
- u_infra_dns_message_internalDomainName
アプリケーション接頭辞一覧
No. | 項目 | 値 | コメント |
---|---|---|---|
1 | 社内DNS | dns_ | サブドメイン名 |
2 | サブドメイン | sdns_ | 社外用ドメイン |
3 | IP/ポート開放 | ipo |
以上