intra-mart Accel Platform BackwardSync(version 7.2へのマスタ同期)仕様書 初版 2013-04-01

IM-共通マスタ同期

機能

IM-共通マスタ同期は、intra-mart Accel PlatformのIM共通マスタ情報を抽出してCSV形式のファイルを出力する機能です。これをおこなうジョブが用意されており、出力されたCSVファイルをiWP / iAFに対してインポートすることでIM共通マスタ同期を実現することができます。 IM共通マスタでは、組織所属役職、組織分類所属、パブリックグループ所属役割、パブリックグループ分類所属の削除は、物理的にデータが削除されてしまうため、物理削除されたデータを同期させるのに、削除情報を補正する処理を行っています。そのため、システムストレージに前回のエクスポートした情報を出力しています。このファイルを使用してエクスポートデータを補正しています。

IM-共通マスタ同期はあくまでintra-mart Accel Platformで動作を行う範囲に限定されています。ゆえに、出力されたファイルをiWP / iAFへインポートを行う必要があります。

コラム

iWP / iAFにはアカウントはCSVとXML形式のインポートを用意していますが、本機能では
CSV形式のみの出力となっており、XML形式は用意されておりません。

対象データ

IM-共通マスタ同期は、以下のデータを対象としています。

  • ユーザ
  • ユーザ分類
  • 会社・組織
  • 役職
  • 組織分類
  • パブリックグループ
  • 役割
  • パブリックグループ分類
  • プライベートグループ

注意

組織分類は、複数会社対応のため、1つの会社の情報しか同期させることができません。
また、すべての会社を対象とする場合には組織分類は同期の対象外となります。

注意

会社グループ、品目、法人・取引先、法人グループ、通貨は対象外となっております。

データマッピング

出力されるCSVの値には、intra-mart Accel Platformの該当データが出力対象となっています。

ユーザ

ヘッダ 名称 該当(テーブル)データ
user_cd ユーザコード imm_user.user_cd
sort_key ソートキー imm_user.sort_key
delete_flag 削除フラグ imm_user.delete_flag
sex 性別 imm_user.sex
locale_id ロケール ID imm_user.locale_id
user_name ユーザ名 imm_user.user_name
user_search_name ユーザ検索名 imm_user.user_search_name
country_cd 国コード imm_user.country_cd
zip_code 郵便番号 imm_user.zip_code
address1 住所1 imm_user.address1
address2 住所2 imm_user.address2
address3 住所3 imm_user.address3
telephone_number 電話番号 imm_user.telephone_number
extension_number 内線番号 imm_user.extension_number
fax_number FAX番号 imm_user.fax_number
extension_fax_number 内線FAX番号 imm_user.extension_fax_number
mobile-number 携帯電話番号 imm_user.mobile-number
email_address1 メールアドレス1 imm_user.email_address1
email_address2 メールアドレス2 imm_user.email_address2
mobile-email-address 携帯メールアドレス imm_user.mobile-email-address
url URL imm_user.url
notes 備考 imm_user.notes

ユーザ分類所属

ヘッダ 名称 該当(テーブル)データ
user_cd ユーザコード imm_user_ctg_ath.user_cd
category_cd 分類コード imm_user_ctg_ath.category_cd
category_item_cd 分類項目コード imm_user_ctg_ath.category_item_cd
delete_flag 削除フラグ imm_user_ctg_ath.delete_flag
delete_flag 削除フラグ(分類)
true trueの場合、ユーザ所属分類を削除。
false  

ユーザ分類

ヘッダ 名称 該当(テーブル)データ
category_cd 分類コード imm_user_ctg.category_cd
delete_flag 削除フラグ imm_user_ctg.delete_flag
category_type 分類タイプ imm_user_ctg.category_type
sort_key ソートキー imm_user_ctg.sort_key
locale_id ロケール ID imm_user_ctg.locale_id
category_name category_name imm_user_ctg.category_name
notes notes imm_user_ctg.notes

ユーザ分類項目

ヘッダ 名称 該当(テーブル)データ
category_cd 分類コード imm_user_ctg_itm.category_cd
category_item_cd 分類項目コード imm_user_ctg_itm.category_item_cd
delete_flag 削除フラグ imm_user_ctg_itm.delete_flag
sort_key ソートキー imm_user_ctg_itm.sort_key
locale_id ロケール ID imm_user_ctg_itm.locale_id
category_item_name 分類項目名 imm_user_ctg_itm.category_item_name
notes 備考 imm_user_ctg_itm.notes

会社・組織

ヘッダ 名称 該当(テーブル)データ
company_cd 会社コード imm_department.company_cd
department_set_cd 組織セットコード imm_department.department_set_cd
department_cd 組織コード imm_department.department_cd
sort_key ソートキー imm_department.sort_key
delete_flag 削除フラグ imm_department.delete_flag
locale_id ロケール ID imm_department.locale_id
department_name 組織名 imm_department.department_name
department_short_name 組織略称 imm_department.department_short_name
department_search_name 組織検索名 imm_department.department_search_name
country_cd 国コード imm_department.country_cd
zip_code 郵便番号 imm_department.zip_code
address1 住所1 imm_department.address1
address2 住所2 imm_department.address2
address3 住所3 imm_department.address3
telephone_number 電話番号 imm_department.telephone_number
extension_number 内線番号 imm_department.extension_number
fax_number FAX番号 imm_department.fax_number
extension_fax_number 内線FAX番号 imm_department.extension_fax_number
email_address1 メールアドレス1 imm_department.email_address1
email_address2 メールアドレス2 imm_department.email_address2
url URL imm_department.url
notes 備考 imm_department.notes

組織内包

ヘッダ 名称 該当(テーブル)データ
company_cd 会社コード imm_department_ath.company_cd
department_set_cd 組織セットコード imm_department_ath.department_set_cd
department_cd 組織コード imm_department_ath.department_cd
parent_department_cd 親組織コード imm_department_ath.parent_department_cd
delete_flag 削除フラグ imm_department_ath.delete_flag

役職

ヘッダ 名称 該当(テーブル)データ
company_cd 会社コード imm_company_post.company_cd
department_set_cd 組織セットコード imm_company_post.department_set_cd
post_cd 役職コード imm_company_post.post_cd
sort_key ソートキー imm_company_post.sort_key
delete_flag 削除フラグ imm_company_post.delete_flag
rank ランク imm_company_post.rank
locale_id ロケール ID imm_company_post.locale_id
post_name 役職名 imm_company_post.post_name
notes 備考 imm_company_post.notes

組織所属/組織所属役職

ヘッダ 名称 該当(テーブル)データ
company_cd 会社コード imm_department_ath.company_cd
department_set_cd 組織セットコード imm_department_ath.department_set_cd
department_cd 組織コード imm_department_ath.department_cd
user_cd ユーザコード imm_department_ath.user_cd
department_main 主所属フラグ imm_department_ath.department_main
delete_flag 削除フラグ imm_department_ath.delete_flag
post_cd 役職コード imm_department_post_ath.post_cd
delete_flag 削除フラグ(役職)
true trueの場合、組織所属役職を削除。
false  

組織分類

ヘッダ 名称 該当(テーブル)データ
category_cd 分類コード imm_department_ctg.category_cd
delete_flag 削除フラグ imm_department_ctg.delete_flag
category_type 分類タイプ imm_department_ctg.category_type
sort_key ソートキー imm_department_ctg.sort_key
locale_id ロケール ID imm_department_ctg.locale_id
category_name 分類名 imm_department_ctg.category_name
notes 備考 imm_department_ctg.notes

組織分類項目

ヘッダ 名称 該当(テーブル)データ
category_cd 分類コード imm_department_ctg_itm.category_cd
category_item_cd 分類項目コード imm_department_ctg_itm.category_item_cd
delete_flag 削除フラグ imm_department_ctg_itm.delete_flag
sort_key ソートキー imm_department_ctg_itm.sort_key
locale_id ロケール ID imm_department_ctg_itm.locale_id
category_item_name 分類項目名 imm_department_ctg_itm.category_item_cd
notes 備考 imm_department_ctg_itm.notes

組織分類所属

ヘッダ 名称 該当(テーブル)データ
company_cd 会社コード imm_department_ctg_ath.company_cd
department_set_cd 組織セットコード imm_department_ctg_ath.department_set_cd
department_cd 組織コード imm_department_ctg_ath.department_cd
category_cd 分類コード imm_department_ctg_ath.category_cd
category_item_cd 分類項目コード imm_department_ctg_ath.category_item_cd
delete_flag 削除フラグ imm_department_ctg_ath.delete_flag
delete_flag 削除フラグ(分類)
true trueの場合、組織分類所属を削除。
false  

パブリックグループ

ヘッダ 名称 該当(テーブル)データ
public_group_set_cd パブリックグループセットコード imm_public_grp.public_group_set_cd
public_group_cd パブリックグループコード imm_public_grp.public_group_cd
sort_key ソートキー imm_public_grp.sort_key
delete_flag 削除フラグ imm_public_grp.delete_flag
locale_id ロケール ID imm_public_grp.locale_id
public_group_name パブリックグループ名 imm_public_grp.public_group_name
public_group_short_name パブリックグループ略称 imm_public_grp.public_group_short_name
public_group_search_name パブリックグループ検索名 imm_public_grp.public_group_search_name
notes 備考 imm_public_grp.notes

パブリックグループ内包

ヘッダ 名称 該当(テーブル)データ
public_group_set_cd パブリックグループセットコード imm_public_grp_ath.public_group_set_cd
public_group_cd パブリックグループコード imm_public_grp_ath.public_group_cd
parent_public_group_cd 親パブリックグループコード imm_public_grp_ath.parent_public_group_cd
delete_flag 削除フラグ imm_public_grp_ath.elete_flag

役割

ヘッダ 名称 該当(テーブル)データ
public_group_set_cd パブリックグループセットコード imm_public_grp_role.public_group_set_cd
role_cd 役割コード imm_public_grp_role.role_cd
sort_key ソートキー imm_public_grp_role.sort_key
delete_flag 削除フラグ imm_public_grp_role.delete_flag
rank ランク imm_public_grp_role.rank
locale_id ロケール ID imm_public_grp_role.locale_id
role_name 役割名 imm_public_grp_role.role_name
notes 備考 imm_public_grp_role.notes

パブリックグループ所属/パブリックグループ所属役割

ヘッダ 名称 該当(テーブル)データ
public_group_set_cd パブリックグループセットコード imm_public_grp_ath.public_group_set_cd
public_group_cd パブリックグループコード imm_public_grp_ath.public_group_cd
user_cd ユーザコード imm_public_grp_ath.user_cd
delete_flag 削除フラグ imm_public_grp_ath.delete_flag
role_cd 役割コード imm_public_grp_role_ath.role_cd
delete_flag 削除フラグ(役割)
true trueの場合、パブリックグループ所属役割を削除。
false  

パブリックグループ分類所属

ヘッダ 名称 該当(テーブル)データ
public_group_set_cd パブリックグループセットコード imm_public_grp_ctg_ath.public_group_set_cd
public_group_cd パブリックグループコード imm_public_grp_ctg_ath.public_group_cd
category_cd 分類コード imm_public_grp_ctg_ath.category_cd
category_item_cd 分類項目コード imm_public_grp_ctg_ath.category_item_cd
delete_flag 削除フラグ imm_public_grp_ctg_ath.delete_flag
delete_flag 削除フラグ(分類)
true trueの場合、パブリックグループ分類所属を削除。
false  

パブリックグループ分類

ヘッダ 名称 該当(テーブル)データ
category_cd 分類コード imm_public_grp_ctg.category_cd
delete_flag 削除フラグ imm_public_grp_ctg.delete_flag
category_type 分類タイプ imm_public_grp_ctg.category_type
sort_key ソートキー imm_public_grp_ctg.sort_key
locale_id ロケール ID imm_public_grp_ctg.locale_id
category_name 分類名 imm_public_grp_ctg.category_name
notes 備考 imm_public_grp_ctg.notes

パブリックグループ分類項目

ヘッダ 名称 該当(テーブル)データ
category_cd 分類コード imm_public_grp_ctg_itm.category_cd
category_item_cd 分類項目コード imm_public_grp_ctg_itm.category_item_cd
delete_flag 削除フラグ imm_public_grp_ctg_itm.delete_flag
sort_key ソートキー imm_public_grp_ctg_itm.sort_key
locale_id ロケール ID imm_public_grp_ctg_itm.locale_id
category_item_name 分類項目名 imm_public_grp_ctg_itm.category_item_cd
notes 備考 imm_public_grp_ctg_itm.notes

プライベートグループ

ヘッダ 名称 該当(テーブル)データ
private_group_cd プライベートグループコード imm_private_grp.private_group_cd
user_cd ユーザコード imm_private_grp.user_cd
sort_key ソートキー imm_private_grp.sort_key
private_group_name プライベートグループ名 imm_private_grp.private_group_name
private_group_search_name プライベートグループ検索名 imm_private_grp.private_group_search_name
notes 備考 imm_private_grp.notes

プライベートグループ所属

ヘッダ 名称 該当(テーブル)データ
private_group_cd プライベートグループコード imm_private_grp_ath.private_group_cd
owner_cd 所有者コード imm_private_grp_ath.owner_cd
user_cd ユーザコード imm_private_grp_ath.user_cd
sort_key ソートキー imm_private_grp_ath.sort_key

機能

IM-共通マスタ同期で用意されている機能は以下のとおりです。

ジョブ

IM共通マスタのCSVファイル出力を実行するためのジョブになります。
jp.co.intra_mart.system.master_backward_sync.job_scheduler.MasterBackwardSyncExporterJob
ジョブ実行パラメータ
キー 説明
EXPORT_CONFIG_FILE_PATH
エクスポートの設定ファイルを指定します。
(パブリックストレージのルートパスからのパス)
backward_sync/im_master/config/master_backward_sync_config.xml

ジョブネット

実行ジョブにIM共通マスタ同期ジョブを指定したものになります。

エクスポート

エクスポータがファイル出力するためのCompanyExporterの実装クラスです。
jp.co.intra_mart.system.master_backward_sync.company.impl.StandardCompanyExporterV7

コラム

ここで用意されている会社・組織のエクスポータ以外は全てIM共通マスタのエクスポータを利用します。

物理削除補正

IM共通マスタから物理削除されたデータを保管するために前回のエクスポート情報と比較するプログラムです。
jp.co.intra_mart.system.master_backward_sync.job_scheduler.MasterBackwardSyncExporterRevisionV7
jp.co.intra_mart.system.master_backward_sync.job_scheduler.UserCorrector
jp.co.intra_mart.system.master_backward_sync.job_scheduler.UserCategoryCorrector
jp.co.intra_mart.system.master_backward_sync.job_scheduler.CompanyCorrector
jp.co.intra_mart.system.master_backward_sync.job_scheduler.PublicGroupCorrector
jp.co.intra_mart.system.master_backward_sync.job_scheduler.PublicGroupCategoryCorrector

シーケンス

IM-共通マスタ同期で用意されている機能がどのようにして実行されるかを示しています。

IM-Master job sequence

設定ファイル

ジョブ実行(master_backward_sync_config.xml)

ジョブを実行する際にファイルのエンコード・フォーマット・保存場所等を指定するために用意しているファイルです。

会社設定

タグ名 company-export
会社・組織のエクスポートを行う場合に設定します。

【設定項目】

<app-master-export>
  <company-export>
    <format>csv</format>
    <encoding>UTF-8</encoding>
    <name>company</name>
    <extension-param name="with-header">true</extension-param>
    <file type="department">backward_sync/im_master/data/companyV7/company-department.csv</file>
    <file type="inclusion">backward_sync/im_master/data/companyV7/company-inclusion.csv</file>
    <file type="post">backward_sync/im_master/data/companyV7/company-post.csv</file>
    <file type="attach-user">backward_sync/im_master/data/companyV7/company-attach-user.csv</file>
    <file type="category">backward_sync/im_master/data/companyV7/company-category.csv</file>
    <file type="item">backward_sync/im_master/data/companyV7/company-item.csv</file>
    <file type="attach-item">backward_sync/im_master/data/companyV7/company-attach-item.csv</file>
    <filter name="company">comp_sample_01</filter>
  </company-export>
</app-master-export>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ app-master-export

タグ名 format
ファイルのフォーマットを設定します。

【設定項目】

<app-master-export>
  <company-export>
    <format>csv</format>
  </company-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容 csv(変更不可)
単位・型 文字列
省略時のデフォルト値 なし
親タグ company-export

タグ名 encoding
出力する文字コードを設定します。

【設定項目】

<app-master-export>
  <company-export>
    <encoding>UTF-8</encoding>
  </company-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容 UTF-8(変更不可)
単位・型 文字列
省略時のデフォルト値 なし
親タグ company-export

タグ名 name

【設定項目】

<app-master-export>
  <company-export>
    <name>company</name>
  </company-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容 エクスポートの処理名を設定します。同名の処理名を持つエクスポートは同時に実行できません。
単位・型 文字列
省略時のデフォルト値 なし
親タグ company-export

タグ名 extension-param
拡張パラメータを設定します。

【設定項目】

<app-master-export>
  <company-export>
    <extension-param name="with-header">true</extension-param>
  </company-export>
</app-master-export>

必須項目 ×
複数設定 ×
設定値・設定する内容
属性nameに対する値 説明 設定値
with-header 最初の1行にヘッダ出力するか指定します。
true 出力します。
false 出力しません。
単位・型 真偽値(true/false)
省略時のデフォルト値 なし
親タグ company-export

【属性】

属性名 説明 必須 デフォルト値
name 指定する拡張要素を決定します。 なし

タグ名 file
ファイルの保存場所(パブリックストレージのルートパスからのパス)を設定します。
同時に、指定した保存場所に履歴用のフォルダを作成して同一ファイル名で保存します。

注意

履歴用に作成されるファイルを定期的に削除する機能はありません。
容量を大量に消費している場合は、適宜削除するようにしてください。

【設定項目】

<app-master-export>
  <company-export>
    <file type="department">backward_sync/im_master/data/companyV7/company-department.csv</file>
    <file type="inclusion">backward_sync/im_master/data/companyV7/company-inclusion.csv</file>
    <file type="post">backward_sync/im_master/data/companyV7/company-post.csv</file>
    <file type="attach-user">backward_sync/im_master/data/companyV7/company-attach-user.csv</file>
    <file type="category">backward_sync/im_master/data/companyV7/company-category.csv</file>
    <file type="item">backward_sync/im_master/data/companyV7/company-item.csv</file>
    <file type="attach-item">backward_sync/im_master/data/companyV7/company-attach-item.csv</file>
  </company-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容
属性typeに対する値 説明 設定値
department 組織情報のcsvファイルの出力先を指定します。 ファイルパス
inclusion 組織内包情報のcsvファイルの出力先を指定します。 ファイルパス
post 会社役職情報のcsvファイルの出力先を指定します。 ファイルパス
attach-user 組織所属・組織役職所属情報のcsvファイルの出力先を指定します。 ファイルパス
category 組織分類情報のcsvファイルの出力先を指定します。 ファイルパス
item 組織分類項目情報のcsvファイルの出力先を指定します。 ファイルパス
attach-item 組織分類所属情報のcsvファイルの出力先を指定します。 ファイルパス
単位・型 文字列
省略時のデフォルト値 なし
親タグ company-export

【属性】

属性名 説明 必須 デフォルト値
type 指定するエンティティを決定します。 なし

注意

category、item、attach-itemを出力する場合は、<filter name=”company”>を指定する必要があります。


タグ名 filter
エクスポートするデータのフィルタリングを設定します。

【設定項目】

<app-master-export>
  <company-export>
    <filter name="company">comp_sample_01</filter>
  </company-export>
</app-master-export>

必須項目 ×
複数設定 ×
設定値・設定する内容
属性nameに対する値 説明 設定値
company 出力する会社を限定します。 会社コード
単位・型 文字列
省略時のデフォルト値 なし
親タグ company-export

【属性】

属性名 説明 必須 デフォルト値
name 指定するフィルターを決定します。 なし

ユーザ設定

タグ名 user-export
ユーザのエクスポートを行う場合に設定します。

【設定項目】

<app-master-export>
  <user-export>
    <format>csv</format>
    <encoding>UTF-8</encoding>
    <name>user</name>
    <extension-param name="with-header">true</extension-param>
    <file type="user">backward_sync/im_master/data/user/user.csv</file>
    <file type="attach-item">backward_sync/im_master/data/user/user-attach-item.csv</file>
  </user-export>
</app-master-export>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ app-master-export

タグ名 format
ファイルのフォーマットを設定します。

【設定項目】

<app-master-export>
  <user-export>
    <format>csv</format>
  </user-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容 csv(変更不可)
単位・型 文字列
省略時のデフォルト値 なし
親タグ user-export

タグ名 encoding
出力する文字コードを設定します。

【設定項目】

<app-master-export>
  <user-export>
    <encoding>UTF-8</encoding>
  </user-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容 UTF-8(変更不可)
単位・型 文字列
省略時のデフォルト値 なし
親タグ user-export

タグ名 name

【設定項目】

<app-master-export>
  <user-export>
    <name>user</name>
  </user-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容 エクスポートの処理名を設定します。同名の処理名を持つエクスポートは同時に実行できません。
単位・型 文字列
省略時のデフォルト値 なし
親タグ user-export

タグ名 extension-param
拡張パラメータを設定します。

【設定項目】

<app-master-export>
  <user-export>
    <extension-param name="with-header">true</extension-param>
  </user-export>
</app-master-export>

必須項目 ×
複数設定 ×
設定値・設定する内容
属性nameに対する値 説明 設定値
with-header 最初の1行にヘッダ出力するか指定します。
true 出力します。
false 出力しません。
単位・型 真偽値(true/false)
省略時のデフォルト値 なし
親タグ user-export

【属性】

属性名 説明 必須 デフォルト値
name 指定する拡張要素を決定します。 なし

タグ名 file
ファイルの保存場所(パブリックストレージのルートパスからのパス)を設定します。
同時に、指定した保存場所に履歴用のフォルダを作成して同一ファイル名で保存します。

注意

履歴用に作成されるファイルを定期的に削除する機能はありません。
容量を大量に消費している場合は、適宜削除するようにしてください。

【設定項目】

<app-master-export>
  <user-export>
    <file type="user">backward_sync/im_master/data/user/user.csv</file>
    <file type="attach-item">backward_sync/im_master/data/user/user-attach-item.csv</file>
  </user-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容
属性typeに対する値 説明 設定値
user ユーザ情報のcsvファイルの出力先を指定します。 ファイルパス
attach-item ユーザ分類所属情報のcsvファイルの出力先を指定します。 ファイルパス
単位・型 文字列
省略時のデフォルト値 なし
親タグ user-export

【属性】

属性名 説明 必須 デフォルト値
type 指定するエンティティを決定します。 なし

ユーザ分類設定

タグ名 user-category-export
ユーザ分類のエクスポートを行う場合に設定します。

【設定項目】

<app-master-export>
 <user-category-export>
    <format>csv</format>
    <encoding>UTF-8</encoding>
    <name>user-category</name>
    <extension-param name="with-header">true</extension-param>
    <file type="category">backward_sync/im_master/data/user_category/user-category.csv</file>
    <file type="item">backward_sync/im_master/data/user_category/user-category-item.csv</file>
  </user-category-export>
</app-master-export>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ app-master-export
タグ名 format
ファイルのフォーマットを設定します。

【設定項目】

<app-master-export>
  <user-category-export>
    <format>csv</format>
  </user-category-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容 csv(変更不可)
単位・型 文字列
省略時のデフォルト値 なし
親タグ user-category-export

タグ名 encoding
出力する文字コードを設定します。

【設定項目】

<app-master-export>
  <user-category-export>
    <encoding>UTF-8</encoding>
  </user-category-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容 UTF-8(変更不可)
単位・型 文字列
省略時のデフォルト値 なし
親タグ user-category-export

タグ名 name

【設定項目】

<app-master-export>
  <user-category-export>
    <name>user-category</name>
  </user-category-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容 エクスポートの処理名を設定します。同名の処理名を持つエクスポートは同時に実行できません。
単位・型 文字列
省略時のデフォルト値 なし
親タグ user-category-export

タグ名 extension-param
拡張パラメータを設定します。

【設定項目】

<app-master-export>
  <user-category-export>
    <extension-param name="with-header">true</extension-param>
  </user-category-export>
</app-master-export>

必須項目 ×
複数設定 ×
設定値・設定する内容
属性nameに対する値 説明 設定値
with-header 最初の1行にヘッダ出力するか指定します。
true 出力します。
false 出力しません。
単位・型 真偽値 (true/false)
省略時のデフォルト値 なし
親タグ user-category-export

【属性】

属性名 説明 必須 デフォルト値
name 指定する拡張要素を決定します。 なし

タグ名 file
ファイルの保存場所(パブリックストレージのルートパスからのパス)を設定します。
同時に、指定した保存場所に履歴用のフォルダを作成して同一ファイル名で保存します。

注意

履歴用に作成されるファイルを定期的に削除する機能はありません。
容量を大量に消費している場合は、適宜削除するようにしてください。

【設定項目】

<app-master-export>
  <user-category-export>
    <file type="category">backward_sync/im_master/data/user_category/user-category.csv</file>
    <file type="item">backward_sync/im_master/data/user_category/user-category-item.csv</file>
  </user-category-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容
属性typeに対する値 説明 設定値
category ユーザ分類情報のcsvファイルの出力先を指定します。 ファイルパス
item ユーザ分類項目情報のcsvファイルの出力先を指定します。 ファイルパス
単位・型 文字列
省略時のデフォルト値 なし
親タグ user-category-export

【属性】

属性名 説明 必須 デフォルト値
type 指定するエンティティを決定します。 なし

パブリックグループ設定

タグ名 public-group-export
パブリックグループのエクスポートを行う場合に設定します。

【設定項目】

<app-master-export>
  <public-group-export>
    <format>csv</format>
    <encoding>UTF-8</encoding>
    <name>public-group</name>
    <extension-param name="with-header">true</extension-param>
    <file type="public-group">backward_sync/im_master/data/public_group/public-group.csv</file>
    <file type="inclusion">backward_sync/im_master/data/public_group/public-group-inclusion.csv</file>
    <file type="role">backward_sync/im_master/data/public_group/public-group-role.csv</file>
    <file type="attach-user">backward_sync/im_master/data/public_group/public-group-attach-user.csv</file>
    <file type="attach-item">backward_sync/im_master/data/public_group/public-group-attach-item.csv</file>
  </public-group-export>
</app-master-export>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ app-master-export

タグ名 format
ファイルのフォーマットを設定します。

【設定項目】

<app-master-export>
  <public-group-export>
    <format>csv</format>
  </public-group-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容 csv(変更不可)
単位・型 文字列
省略時のデフォルト値 なし
親タグ public-group-export

タグ名 encoding
出力する文字コードを設定します。

【設定項目】

<app-master-export>
  <public-group-export>
    <encoding>UTF-8</encoding>
  </public-group-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容 UTF-8(変更不可)
単位・型 文字列
省略時のデフォルト値 なし
親タグ public-group-export

タグ名 name

【設定項目】

<app-master-export>
  <public-group-export>
    <name>public-group</name>
  </public-group-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容 エクスポートの処理名を設定します。同名の処理名を持つエクスポートは同時に実行できません。
単位・型 文字列
省略時のデフォルト値 なし
親タグ public-group-export

タグ名 extension-param
拡張パラメータを設定します。

【設定項目】

<app-master-export>
  <public-group-export>
    <extension-param name="with-header">true</extension-param>
  </public-group-export>
</app-master-export>

必須項目 ×
複数設定 ×
設定値・設定する内容
属性nameに対する値 説明 設定値
with-header 最初の1行にヘッダ出力するか指定します。
true 出力します。
false 出力しません。
単位・型 真偽値(true/false)
省略時のデフォルト値 なし
親タグ public-group-export

【属性】

属性名 説明 必須 デフォルト値
name 指定する拡張要素を決定します。 なし

タグ名 file
ファイルの保存場所(パブリックストレージのルートパスからのパス)を設定します。
同時に、指定した保存場所に履歴用のフォルダを作成して同一ファイル名で保存します。

注意

履歴用に作成されるファイルを定期的に削除する機能はありません。
容量を大量に消費している場合は、適宜削除するようにしてください。

【設定項目】

<app-master-export>
  <public-group-export>
    <file type="public-group">backward_sync/im_master/data/public_group/public-group.csv</file>
    <file type="inclusion">backward_sync/im_master/data/public_group/public-group-inclusion.csv</file>
    <file type="role">backward_sync/im_master/data/public_group/public-group-role.csv</file>
    <file type="attach-user">backward_sync/im_master/data/public_group/public-group-attach-user.csv</file>
    <file type="attach-item">backward_sync/im_master/data/public_group/public-group-attach-item.csv</file>
  </public-group-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容
属性typeに対する値 説明 設定値
public-group パブリックグループ情報のcsvファイルの出力先を指定します。 ファイルパス
inclusion パブリックグループ内包情報のcsvファイルの出力先を指定します。 ファイルパス
role パブリックグループ役割情報のcsvファイルの出力先を指定します。 ファイルパス
attach-user パブリックグループ所属・パブリックグループ所属役割情報のcsvファイル の出力先を指定します。 ファイルパス
attach-item パブリックグループ分類所属情報のcsvファイルの出力先を指定します。 ファイルパス
単位・型 文字列
省略時のデフォルト値 なし
親タグ public-group-export

【属性】

属性名 説明 必須 デフォルト値
type 指定するエンティティを決定します。 なし

パブリックグループ分類設定

タグ名 public-group-category-export
パブリックグループ分類のエクスポートを行う場合に設定します。

【設定項目】

<app-master-export>
  <public-group-category-export>
    <format>csv</format>
    <encoding>UTF-8</encoding>
    <name>public-group-category</name>
    <extension-param name="with-header">true</extension-param>
    <file type="category">backward_sync/im_master/data/public_group_category/public-group-category.csv</file>
    <file type="item">backward_sync/im_master/data/public_group_category/public-group-category-item.csv</file>
  </public-group-category-export>
</app-master-export>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ app-master-export

タグ名 format
ファイルのフォーマットを設定します。

【設定項目】

<app-master-export>
  <public-group-category-export>
    <format>csv</format>
  </public-group-category-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容 csv(変更不可)
単位・型 文字列
省略時のデフォルト値 なし
親タグ public-group-category-export

タグ名 encoding
出力する文字コードを設定します。

【設定項目】

<app-master-export>
  <public-group-category-export>
    <encoding>UTF-8</encoding>
  </public-group-category-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容 UTF-8(変更不可)
単位・型 文字列
省略時のデフォルト値 なし
親タグ public-group-category-export

タグ名 name

【設定項目】

<app-master-export>
  <public-group-category-export>
    <name>public-group-category</name>
  </public-group-category-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容 エクスポートの処理名を設定します。同名の処理名を持つエクスポートは同時に実行できません。
単位・型 文字列
省略時のデフォルト値 なし
親タグ public-group-category-export

タグ名 extension-param
拡張パラメータを設定します。

【設定項目】

<app-master-export>
  <public-group-category-export>
    <extension-param name="with-header">true</extension-param>
  </public-group-category-export>
</app-master-export>

必須項目 ×
複数設定 ×
設定値・設定する内容
属性nameに対する値 説明 設定値
with-header 最初の1行にヘッダ出力するか指定します。
true 出力します。
false 出力しません。
単位・型 真偽値 (true/false)
省略時のデフォルト値 なし
親タグ public-group-category-export

【属性】

属性名 説明 必須 デフォルト値
name 指定する拡張要素を決定します。 なし

タグ名 file
ファイルの保存場所(パブリックストレージのルートパスからのパス)を設定します。
同時に、指定した保存場所に履歴用のフォルダを作成して同一ファイル名で保存します。

注意

履歴用に作成されるファイルを定期的に削除する機能はありません。
容量を大量に消費している場合は、適宜削除するようにしてください。

【設定項目】

<app-master-export>
  <public-group-category-export>
    <file type="category">backward_sync/im_master/data/public_group_category/public-group-category.csv</file>
    <file type="item">backward_sync/im_master/data/public_group_category/public-group-category-item.csv</file>
  </public-group-category-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容
属性typeに対する値 説明 設定値
category パブリックグループ分類情報のcsvファイルの出力先を指定します。 ファイルパス
item パブリックグループ分類項目情報のcsvファイルの出力先を指定します。 ファイルパス
単位・型 文字列
省略時のデフォルト値 なし
親タグ public-group-category-export

【属性】

属性名 説明 必須 デフォルト値
type 指定するエンティティを決定します。 なし

プライベートグループ設定

タグ名 public-group-category-export
プライベートグループのエクスポートを行う場合に設定します。

【設定項目】

<app-master-export>
  <private-group-export>
    <format>csv</format>
    <encoding>UTF-8</encoding>
    <name>private-group</name>
    <extension-param name="with-header">true</extension-param>
    <file type="private-group">backward_sync/im_master/data/private_group/private-group.csv</file>
    <file type="attach-user">backward_sync/im_master/data/private_group/private-group-attach-user.csv</file>
  </private-group-export>
</app-master-export>

必須項目 ×
複数設定 ×
設定値・設定する内容 なし
単位・型 なし
省略時のデフォルト値 なし
親タグ app-master-export

タグ名 format
ファイルのフォーマットを設定します。

【設定項目】

<app-master-export>
  <private-group-export>
    <format>csv</format>
  </private-group-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容 csv(変更不可)
単位・型 文字列
省略時のデフォルト値 なし
親タグ private-group-export

タグ名 encoding
出力する文字コードを設定します。

【設定項目】

<app-master-export>
  <private-group-export>
    <encoding>UTF-8</encoding>
  </private-group-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容 UTF-8(変更不可)
単位・型 文字列
省略時のデフォルト値 なし
親タグ private-group-export

タグ名 name

【設定項目】

<app-master-export>
  <private-group-export>
    <name>private-group</name>
  </private-group-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容 エクスポートの処理名を設定します。同名の処理名を持つエクスポートは同時に実行できません。
単位・型 文字列
省略時のデフォルト値 なし
親タグ private-group-export

タグ名 extension-param
拡張パラメータを設定します。

【設定項目】

<app-master-export>
  <private-group-export>
    <extension-param name="with-header">true</extension-param>
  </private-group-export>
</app-master-export>

必須項目 ×
複数設定 ×
設定値・設定する内容
属性nameに対する値 説明 設定値
with-header 最初の1行にヘッダ出力するか指定します。
true 出力します。
false 出力しません。
単位・型 真偽値 (true/false)
省略時のデフォルト値 なし
親タグ private-group-export

【属性】

属性名 説明 必須 デフォルト値
name 指定する拡張要素を決定します。 なし

タグ名 file
ファイルの保存場所(パブリックストレージのルートパスからのパス)を設定します。
同時に、指定した保存場所に履歴用のフォルダを作成して同一ファイル名で保存します。

注意

履歴用に作成されるファイルを定期的に削除する機能はありません。
容量を大量に消費している場合は、適宜削除するようにしてください。

【設定項目】

<app-master-export>
  <public-group-export>
    <file type="private-group">backward_sync/im_master/data/private_group/private-group.csv</file>
    <file type="attach-user">backward_sync/im_master/data/private_group/private-group-attach-user.csv</file>
  </public-group-export>
</app-master-export>

必須項目
複数設定 ×
設定値・設定する内容
属性typeに対する値 説明 設定値
private-group プライベートグループ情報のcsvファイルの出力先を指定します。 ファイルパス
attach-user プライベートグループ所属情報のcsvファイルの出力先を指定します。 ファイルパス
単位・型 文字列
省略時のデフォルト値 なし
親タグ private-group-export

【属性】

属性名 説明 必須 デフォルト値
type 指定するエンティティを決定します。 なし