docushare コマンドラインユーティリティガイド

70
DocuShare コマンドラインユーティリティガイド

Upload: others

Post on 22-Oct-2021

12 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: DocuShare コマンドラインユーティリティガイド

DocuShare

コマンドラインユーティリティガイド

Page 2: DocuShare コマンドラインユーティリティガイド

発行日:2011 年 5 月

この文書は、DocuShare リリース 6.6.1 に対応している。

正規のマニュアルは、下記で提供されている英語版の『DocuShare コマンドラインユーティリティガイド』です。

DocuShare の Web ページ > ヘルプ > 開発者ツール > 『DocuShare コマンドラインユーティリティガイド』

(管理者のみアクセス可能)

本ドキュメントは、『DocuShare コマンドラインユーティリティガイド』の日本語参考訳です。

作成者:

Xerox Corporation

DocuShare Business Unit

3400 Hillview Avenue・・Palo Alto,

California 94304

USA

© 2011 Xerox Corporation.All rights reserved.Xerox®、DocuShare®、Fuji Xerox®、および Document Company®は、米国およびその

他の国において Xerox Corporation の商標である。その他の商標はすべて、それぞれの企業の所有物であり、そのように認識されている。

Page 3: DocuShare コマンドラインユーティリティガイド

目次

第 1 章 DocuShare CLI の概要

セキュリティ. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–1 ユーティリティ格納場所. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–1

コマンド構文. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–2 コマンド. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–2

[options]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–2 ハンドルまたはクラス名 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–2 <引数>または<操作>. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–2

DocuShare データファイル. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . 1–3 XML オブジェクト定義ファイル . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–3 CSV オブジェクト定義形式 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–5

第 2 章 DocuShare コマンド

DocuShare コマンド一覧表 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–2

changeSubscriptionSvcState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4

changeSubscriptionSvcState のオプション. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4

changeSubscriptionSvcState の使用例. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4

countFileNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–5

countFileNumber のオプション. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–5

countFileNumber の使用例. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–5

diagevent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–6 diagevent のオプション. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–6 diagevent の使用例. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–6

diaggovernor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–7

diaggovernor の出力. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–7

dscli . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–8

dsdelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . .. . . . . . . . . . . . . . . 2–9 dsdelete のオプション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–9 dsdelete の使用例. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–9

dsexport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–10 dsexport のオプション. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–10 dsexport の使用例. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–11 dsexport の動作について. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–13

dsgetprop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–14 dsgetprop のオプション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–14 dsgetprop の使用例. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–14

dslistprop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–15 dslistprop のオプション. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–15 dslistprop の使用例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–15

dssetprop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–16 dssetprop のオプション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . 2–16 dssetprop の使用例. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–17

サーバープロパティ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–18 dslistprop、dsgetprop、および dssetprop の使用例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–21

DocuShare Command Line Utilities Guide iii

Page 4: DocuShare コマンドラインユーティリティガイド

Table of Contents

dsimport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–22 レジューム機能.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–22 dsimport のオプション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–23 dsimport の操作. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–25

大量オブジェクトのインポート . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–25 dsimport の使用例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–26 dsimport の動作について . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–27 パスワード . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–28

dsindex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–29 dsindex のオプション. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–29 dsindex の操作 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–30

dsinfo . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–31 dsinfo のオプション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–31 dsinfo の使用例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–31

dslock . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–32 dslock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–32

dslock のオプション. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–32

dsorphan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–33 dsorphan のオプション. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–33 dsorphan の操作 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . 2–33 dsorphan の使用例. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–33

dsservice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . 2–34 dsservice のオプション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . 2–34 dsservice の操作 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–34 dsservice のサービス引数 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–35

dssetup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–36 dssetup の引数 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–36

システム構成 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–36

dsstats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–39 dsstats のオプション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–39 dsstats の使用例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–39

dstrashcan . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–40 dstrashcan のオプション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–40 dstrashcan の操作 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–40 dstrashcan の使用例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–40

dsunlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–41 dsunlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–41

dsunlock のオプション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–41

dsupload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–42 dsupload のオプション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–42 dsupload の使用例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–43

fixupMimeTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-44

fixupMimeTypes のオプション. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-44

fixupMimeTypes の使用例. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-44

iv DocuShare Command Line Utilities Guide

Page 5: DocuShare コマンドラインユーティリティガイド

Table of Contents

getIndexReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–45

getIndexReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–45

idoltool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–46

idoltool の使用 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–46

idoltool のコマンド . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. 2–46

export/import を使用して IDOL インデックスデータベースをバックアップ、復元する. . . . . . . . . . . .. 2–48

idolsetup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–49

idolsetup のオプション. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–49

idolsetup の使用例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–49

recoverindex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–50

recoverindex のオプション. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–50

recoverindex の使用例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–50

reindexChangesSince . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–51

reindexChangesSince の操作. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–51

reindexChangesSince の使用例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–51

resetIndexes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-52

resetIndexes のオプション. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-52

setindexconfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–53

setindexconfig のオプション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–53

indexServerConfig.xml のプロパティ名と値 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–53

setStorageUpgradeConfig. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–55

setStorageUpgradeConfig のオプション . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–55

setStorageUpgradeConfig の使用例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–55

start_docushare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–56 start_docushare の引数 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–56

stop_docushare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–57 stop_docushare のオプション. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–57

stop_docushare の引数. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–57

Windows サーバーのみにおける注意点 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–57

DocuShare Command Line Utilities Guide v

Page 6: DocuShare コマンドラインユーティリティガイド

Table of Contents

vi DocuShare Command Line Utilities Guide

Page 7: DocuShare コマンドラインユーティリティガイド

1 DocuShare CLI の概要 DocuShare コマンドラインインターフェースは、管理者に、オブジェクトやサーバーのプロパティを参照し、編集するための様々なユーティリティを

提供する。コマンドラインインターフェースにより、物理的な DocuShare サーバー上のシェルから、DocuShare リポジトリを使用して読み取り/

書き込みトランザクションを実行することが可能になる。管理者はこのインターフェースを利用することにより、ネットワーク転送を介することなく、

直接 DocuShare リポジトリに対するデータレベルの操作を実行することができる。これらの操作では、XML ベースの入力/出力形式を用い

て、データを表す。

セキュリティ

サーバーのセキュリティは、DocuShare 管理者がコマンドにアクセスし、シェルからリポジトリファイルに書き込む機能を基盤としている。一方、こ

れらの機能は、サーバーOS によって、また、DocuShare インストールツリーにおけるファイルシステムの読み取り/書き込み権設定によって管

理されている。

デフォルトでは、コマンドラインユーティリティは DocuShare admin 権限で実行する。そのため、DocuShare コマンドラインインターフェースは、

常にすべての操作を実行する権限を持っていることになる。ただし、サーバーライセンスの有効期限が切れている場合など、admin が操作の

実行を許可されない場合は除く。

コマンドラインユーティリティを、admin ではなく、特定のユーザーの権限で実行する場合は、そのユーザーが特定のオブジェクトに対してその操

作を実行する権限を持たない場合、DocuShare はコマンド要求を受け付けないことがある。

ユーティリティ格納場所

すべての DocuShare コマンドは、DocuShare をインストールした場所の Xerox\Docushare\bin ディレクトリに格納されている。

DocuShare コマンドラインユーティリティを実行する前に、必ず bin ディレクトリに cd(ディレクトリ変更)する。

注:bin ディレクトリの中には、pyc ファイルや config.bat ファイルなど手動で実行してはならないコマンドがいくつか存在する。DocuShare のシ

ステムおよびシステムツールがこれらのコマンドを使用する。本ガイドで説明されているコマンドのみを実行してください。

DocuShare Command Line Utilities Guide 1–1

Page 8: DocuShare コマンドラインユーティリティガイド

Command syntax Introduction to the DocuShare CLI

コマンド構文

ほとんどの DocuShare コマンドは、以下の構文となっている。

コマンド [オプション] ハンドルまたはクラス名 <引数または操作>

コマンド

DocuShare 固有のコマンド。

[オプション]

すべての DocuShare コマンドで、以下に挙げる基本オプションセットを使用することができる。一部の DocuShare コマンドには、コマンド固有

のオプションがある。コマンド固有のオプションについては、第 2 章の各コマンドに対する項で説明する。

基本オプションセット

-h ヘルプ。コマンドのヘルプを表示する。

-q Quiet。コマンドを Quiet モードで実行する。すべての情報メッセージと、ユーザーによる「はい」または「い

いえ」の入力を促すプロンプトの表示を抑制する。すべてのプロンプトに対して、「はい」が入力されたも

のとみなす。その際の実行結果についてはユーザーの責任となる。

-u ユーザー。コマンドを指定されたユーザーの権限で実行する。引数としてユーザーハンドルが必要。デフ

ォルトでは、すべてのコマンドを adim ユーザーの権限で実行する。これにより、コマンドにはすべての権

限が与えられ、また、admin はコマンドにより実行されるすべての編集操作の実行者となる。例えば、-

u User-12 と指定すると、コマンドは admin ではなく、User-12 の権限で実行される。

ハンドルまたはクラス名

ハンドルまたはクラス名引数は、DocuShare ハンドル(例:Collection-47)、または、

DocuShare クラス名(例:User)で、コマンドを適用するオブジェクトを指定する。コマンドの中には、特定のリポジトリオブジェクトまたはサーバー

自体に適用されるものもある。また、ハンドルやクラス名として、複数のハンドル、クラス名、または両者の組み合わせを指定可能なコマンドも

ある。ハンドルとクラス名では、大文字と小文字が区別される。また、 初の文字は、User や Collection などのように大文字でなければなら

ない。

<引数>または<操作>

add や modify など、コマンドで実行する処理を指定する。すべてのコマンドに引数や操作があるわけではない。引数として、プロパティ名と値

(PropertyName_value)をペアで指定する場合もある。

1–2 DocuShare Command Line Utilities Guide

Page 9: DocuShare コマンドラインユーティリティガイド

Introduction to the DocuShare CLI DocuShare data files

DocuShare データファイル

DocuShare コマンドラインルーチンの中には、単一のオブジェクトやオブジェクト階層全体をエクスポートまたはインポートできるものがある。

DocuShare コマンドラインを使用することにより、管理者は、あるサーバーから別のサーバーへと大容量のデータを移動させたり、オブジェクトを

生成または処理するカスタムアプリケーションを構築したりすることができる。

リリース 6 では、オブジェクトを表現し転送するための DocuShare オブジェクト定義ファイル形式として、CSV または XML ベースの形

式を使用することができる。

XML オブジェクト定義ファイル

DocuShare オブジェクト定義ファイルは、DocuShare ドキュメントタイプ定義に対して Well-formed かつ Valid である必要がある。特に許

可されている場合を除き、DocuShare オブジェクト定義ファイルは、自己完結型でなければならず、ファイルの外部に定義されているオブジ

ェクトハンドルを参照することはできない。この条件は、ポータビリティを確実に実現するためのものである。特定のモードでは、各オブジェクト

を定義するために用いるハンドルが、対象リポジトリのハンドルと一致することが要求されるコマンドもある。 各オブジェクトは、DocuShare dsobject エレメントを用いて、以下のように定義される。

<!ELEMENT dsobject ( prop ) >

<!ATTLIST dsobject

type NMTOKEN #REQUIRED

handle ID #IMPLIED >

type 属性

dsobject の type 属性は、宣言されたオブジェクトのクラスを定義する。その値は、既知の DocuShare オブジェクトクラスの名前でなければな

らない。有効なクラス名としては、Bulletin、BulletinBoard、Calendar、Collection、Document、Event、Group、SavedQuery、Subscription、

URL、User などがある。

handle 属性(オプション)

dsobject の handle 属性(オプション)は、オブジェクトを一意に識別するためのトークンである。これにより、オブジェクト定義ファイルの別の

場所においてそのオブジェクトを参照することができるようになる。handle 属性の値は、ファイル内のすべての dsobject ハンドルにおいて一

意でなければならない。handle トークンは、クラス名 - 番号という標準の DocuShare ハンドル命名規則に従って命名する必要がある。た

だし、add 操作については、以下の条件がある。

• ハンドルは、オブジェクト定義ファイルのコンテキスト内においてのみ、主にオブジェクト間の参照を可能とするために使用される。

• ハンドルは、特定のサーバー上の既存オブジェクトへの参照として解釈されることがあってはならない。

エクスポート操作において、オブジェクト定義ファイル内のオブジェクトハンドルは、ソースサーバーに存在するオブジェクトハンドルと同じトークンを

使用することができる。そのハンドルは、エクスポートコマンドを発行した時点で、そのオブジェクトを表すものと解釈することができる。オブジェク

ト定義では、handle 属性を省略することができる。その場合は、匿名のオブジェクトを定義することになる。匿名オブジェクトは、オブジェクト定

義ファイル内の別の場所から参照することはできない。

DocuShare Command Line Utilities Guide 1–3

Page 10: DocuShare コマンドラインユーティリティガイド

DocuShare data files Introduction to the DocuShare CLI

dsobject 宣言の内容は、単一の prop エレメントとなり、このエレメントの内容は、オブジェクトのプロパティとその値の集合で構成される。

dsobject 宣言は、props、sourcelinks、destinationlinks、acls という 4 つの基本的なセクションで構成される。エクスポートされた

Document-xx の versions セクションなど、クラスによっては、他のオプションのセクションを持つこともある。以下に、例を示す。

<dsobject handle = "Collection-11" classname ="Collection" baseClassname = "Collection">

<props>

<prop name="create_date" type="4">Sat Jun 01 07:32:00 PDT 2002</prop>

<prop name="sort_order" type="20">TypeAndTitle</prop>

<prop name="client_data" type="10"></prop>

<prop name="modified_date" type="4">Sat Jun 01 07:32:00 PDT 2002</prop>

<prop name="add_as_draft" type="3">false</prop> <prop name="logo" type="10"></prop>

<prop name="expiration_date" type="4" /> <prop name="keywords" type="10"></prop>

<prop name="summary" type="10"></prop> <prop name="bg_image" type="10"></prop>

<prop name="locale" type="10">en_US</prop> <prop name="title" type="10">Initial Top Level Collection

B</prop>

<prop name="view_format" type="20">DetailedListing</prop> <prop name="description" type="11"></prop>

</props>

<sourcelinks>

</sourcelinks>

<destinationlinks>

<containment>Collection-16</containment>

<owner>User-2</owner>

</destinationlinks>

<acls>

<ace principal="Group-2" permissions="manage,read,search,write"/>

<ace principal="Group-4" permissions="read,search"/>

<ace principal="Group-5" permissions="read,search,write"/>

</acls>

</dsobject>

1–4 DocuShare Command Line Utilities Guide

Page 11: DocuShare コマンドラインユーティリティガイド

Introduction to the DocuShare CLI DocuShare data files

CSV オブジェクト定義形式

CSV(Comma Separated Value)ファイル形式を、個々のオブジェクトのプロパティを記述するために XML の代わりに使用することができる。

CSV ファイルは、カンマで区切られたオブジェクト値の列からなる行で構成される。CSV ファイルは、ほとんどのスプレッドシートやデータベースア

プリケーションによって容易に参照することができる。

• リリース 6 では、 Version、 Rendition、 Subscripton、 SavedQuery を除く、ほとんどのデフォルトの DocuShare サイトオブジェクトに

対し CSV ファイル形式がサポートされる。

• またリリース 6 は、カスタムオブジェクトに対する CSV ファイル形式もサポートする。ただし、Subscription、User、Group、Version、また

は Rendition から派生したカスタムオブジェクトは除く。

• リリース 6 では、 オブジェクトのアクセス権(ACL)、ファイルバージョン履歴、または暗号化されたユーザーパスワード情報に関しては

CSV ファイル形式はサポートしない。

CSV 形式では、同一クラスのオブジェクトを 1 つのセクションにまとめる。各セクションでは、そのクラスに対するスキーマと、各オブジェクト

のプロパティ列を定義する。

例えば、オブジェクトクラスのオブジェクト集合は以下のようになる。

1 行目: class-name

1 行目では、クラス名を宣言する。クラス名は、有効な DocuShare クラス名でなければならない。例としては、 Collection や Bulletin などがある。

2 行目: property-name1、property-name2、…、property-namen

2 行目では、そのクラス内のオブジェクトのカラムを定義する。各カラムは、オブジェクトプロパティの名前である。

すべてのカラムは、そのクラス内のオブジェクトの有効なプロパティに対応していなければならない。ただし、クラス内のオブジェクトのすべての

プロパティに対し、カラムが必要というわけではない。

3 行目: obj1.property1, obj1.property2, …, obj1.propertyn

続く各行では、このクラスに属する新しいオブジェクトを定義する。オブジェクト x.プロパティ m は、オブジェクト x のプロパティ名 m に対する

値を表する。各クラスの区切りには、空行を挿入する。カンマを含む値は、シングルクォート(‘...’)またはダブルクォート(“...”)で囲む必要

がある。

n+2 行目: objn.property1, objn.property2, …, objn.propertyn

2 名の User と 1 つの Collection を定義する CSV の例

User

first_name, last_name, username, email・・John, Smith,

jsmith, [email protected]

Mary, Anderson, anderson, [email protected]

Collection

title, summary, keywords

Sales collaterals, "Sales brochures, price quotes, etc.", sales

DocuShare Command Line Utilities Guide 1–5

Page 12: DocuShare コマンドラインユーティリティガイド

DocuShare data files Introduction to the DocuShare CLI

1–6 DocuShare Command Line Utilities Guide

Page 13: DocuShare コマンドラインユーティリティガイド

2 DocuShare コマンド

本章では、DocuShare サーバーを管理に使用できるすべての DocuShare コマンドラインユーティリティについて説明する。 各コマンドに対し、以下の項目がある(コマンドによっては、存在しないものもある)。

• 構文

• コマンドの説明

• コマンドのオプション

• 使用例

DocuShare Command Line Utilities Guide 2–1

Page 14: DocuShare コマンドラインユーティリティガイド

DocuShare commands table DocuShare Commands

DocuShare コマンド一覧表

各コマンドについては、この表の後の部分で説明する。

表 2–1:DocuShare コマンドラインユーティリティ

コマンド 使用目的 changeSubscriptionSvcState 通知サービスの動作状態を変更するために使用する。

countFileNumber サイト上のファイルを検索して、それぞれのファイルサイズの範囲内で見つかったファ

イル数を MIME タイプごとに表示するために使用する。 fixupMimeTypes コマンド

と併せて使用する。

diagevent サイトイベントキューの管理と診断に使用する。

注意:このコマンドを使用する前に、DocuShare カスタマーサポートに連絡してくだ

さい。

diaggovernor DocuShare サーバー統計のコマンドの統計テーブルに示される情報を表示する

ために使用する。このコマンドは、DocuShare サイトがフリーズしたように見え、サ

ーバー統計の UI ページが表示できないときに便利な診断ツールである。

dscli dsimport、dsexport、dsdelete、dslistprop、dsgetprop、dssetprop、dslock、

dsunlock、および dsservice コマンドに対するすべてのヘルプページを表示すると

きに使用する。

dsdelete サイトオブジェクトを削除するために使用する。

dsexport サイトオブジェクトを、XML ベースまたは CSV ベースの DocuShare オブジェクト定

義ファイル形式にエクスポートするために使用する。

dsgetprop 特定のプロパティの値や特定のオブジェクトやサーバーのリンクを参照するために

使用する。

dsimport 大容量のサイトオブジェクトを DocuShare リポジトリにインポートしたり、既存のオ

ブジェクトを大量のデータで更新したりするために使用する。

dsindex DocuShare 検索データベースの圧縮、クリーンアップ、再インデックス、 適化を

行なうために使用する。

dsinfo 各 DocuShare jar ファイルに関する情報を取得するために使用する。

dslistprop 特定の DSClass クラス名およびサーバーのプロパティとリンクの一覧を表示するた

めに使用する。

dslock 特定の DocuShare ドキュメントオブジェクトをロックするために使用する。

dsorphan 孤立オブジェクトを一覧表示し、再割り当てるために使用する。

dsservice DocuShare サービスを制御するためのモニタープログラムを使用する。

注意:このコマンドを使用する前に、DocuShare カスタマーサポートに連絡してく

ださい。

2–2 DocuShare Command Line Utilities Guide

Page 15: DocuShare コマンドラインユーティリティガイド

DocuShare Commands DocuShare commands table

表 2–1:DocuShare コマンドラインユーティリティ

コマンド 使用目的 dssetprop 特定のオブジェクトやサーバーの特定のプロパティの値を変更するために使用する。

dssetup DocuShare 構成プロパティと値を変更するために使用する。

dsstats DocuShare サーバー統計を一覧表示する。

dstrashcan DocuShare ごみ箱の中のオブジェクトを、一覧表示、復元、または抹消するため

に使用する。

dsunlock 特定の DocuShare ドキュメントオブジェクトをアンロックする。

dsupload 複数のドキュメントを複数のコレクションにアップロードするために使用する。

fixupMimeTypes 不整合な MIME タイプを確認して、修復するために使用する。このコマンドは、

index_all を実行する前ではなく、サイトをアップグレードした後に使用する。

countFileNumber コマンドと併せて使用する。

getIndexReport リレーショナルデータベースと検索データベースに格納されたオブジェクト数を比較

するために使用する。

idoltool IDOL 検索/インデックスサーバーの設定と管理をするために使用する。

注意:このコマンドを使用する前に、DocuShare カスタマーサポートに連絡してく

ださい。

idolsetup IDOL サービスが動作している 64 ビットサーバーのメモリリソースにマッチする IDOL

サービスを構成することによってインデックスの動作を 適化するために使用する。

recoverIndex DocuShare によって記録されたあらゆる検索データベースの障害を発見し、かつ

検索データベースの問題が解決された後にオペレーションを再び試みるために使

用する。

reindexChangesSince 指定した日付以来作成されているか修正されたサイトのコンテンツを再インデック

スするために使用する。

resetIndexes DocuShare データベースインデックスのデフォルトの設定を再構築するために使用

する。

setindexconfig IndexServerConfig.xml ファイル内のプロパティの値を設定するために使用する。

setStorageUpgradeConfig コンテンツストアをアップグレードする機能の有効化/無効化の設定とその実行時

間を設定するために使用する。

start_docushare DocuShare の起動とランタイム環境を制御するために使用する。

stop_docushare DocuShare サービスを停止するために使用する。dsservice shutdown と同じ機

能。

DocuShare Command Line Utilities Guide 2–3

Page 16: DocuShare コマンドラインユーティリティガイド

changeSubscriptionSvcState DocuShare Commands

changeSubscriptionSvcState

構文:changeSubscriptionSvcState [オプション]

changeSubscriptionSvcState コマンドは、通知サービスの動作状態を変更するために使用される。有効なオプションの一つを使用して、サー

ビスを指定の動作状態にセットする。

changeSubscriptionSvcState のオプション

enable 通知サービスを有効にする。

pause 通知サービスを無効にする。全ての通知処理を停止する。イベントは、通知キューに発生し続ける。

remove 通知サービスを無効にする。全ての通知処理とイベントキューを停止する。キューにある全てのイベント

を削除する。

changeSubscriptionSvcState の使用例

changeSubscriptionSvcState remove — 通知サービスを無効にして、イベントの受付を止め、キューにあるすべてのイベントを削除す

る。

2–4 DocuShare Command Line Utilities Guide

Page 17: DocuShare コマンドラインユーティリティガイド

DocuShare Commands countFileNumber

countFileNumber

構文:countFileNumber [オプション]<サーバー名><ドメイン><ユーザー名><パスワード><RMI ポート>

countFileNumber コマンドは、fixupMimeTypes コマンドと併せて使用される。countFileNumber コマンドは、サイト上のファイルを検索して、

それぞれのファイルサイズの範囲内で見つかった(インデックスされるかされないかを示し)ファイル数を MIME タイプごとに表示する。

ファイルサイズの範囲:

0M から 1M の間

1M から 5M の間

5M から 20M の間

20M から 50M の間

50M から 100M の間

100M 以上

countFileNumber のオプション

-h コマンドのヘルプを表示する。

-l 出力のログファイル。デフォルトは、stdout。

<サーバー名> localhost など。

<ドメイン> ログインしたドメイン;DocuShare など。

<ユーザー名> 管理者権限を持つログイン名

<パスワード> ログイン名のパスワード

< RMI ポート> RMI ポート番号

countFileNumber の使用例

countFileNumber -l localhost DocuShare admin admin 1099 — それぞれのファイルサイズの範囲内で見つかったファイル数を MIME

タイプごとに表示する。この例では、一つのインデックスされた PDF ファイル(実際のサイズは 3MB)が見つかり、それが"File size between

1M and 5M"の下に表示される。

File size between 0M and 1M

MIME type: application/octet-stream has not been indexed. Total file number: 4

MIME type: text/plain has been indexed. Total file number: 2238

MIME type: application/msword has been indexed. Total file number: 5

MIME type: text/html has been indexed. Total file number: 18

File size between 1M and 5M

MIME type: application/pdf has been indexed. Total file number: 1

DocuShare Command Line Utilities Guide 2-5

Page 18: DocuShare コマンドラインユーティリティガイド

diagevent DocuShare Commands

diagevent

構文:diagevent [オプション] queue name または batch または sequence number または all

diagevent コマンドは、サイトイベントキューの診断を管理し、実行する。Diagevent コマンドは、diagtool の代替である。

注意:このコマンドを使用する前に、DocuShare カスタマーサポートに連絡してください。

diagevent のオプション

all 全てのキューを表示する。

blocking キューがそれぞれブロッキングイベントエミッションにどれくらい近いか示すサマリーを表示

delete 指定の名前のキューを削除する。all を使わないこと。

display キューのプロパティと全てのイベントを表示する。特定の<キュー名>あるいはすべてのいずれかを表示す

るように指定する。

drop 与えられたキューからトップ n のイベントをドロップする。これは永続化せず、ブロックもしません。キュー

からドロップするためのキュー名およびイベント数を指定する。(全てのイベントをドロップするためには 1

を入力する。)

h コマンドのヘルプを表示する。

remove 指定のキューと永続ストレージからイベントを削除する。キュー名(キューから全ての保存イベントを削

除する場合)、あるいはキュー名、バッチ ID、シーケンス番号(キューから特定のイベントを削除する場

合)を指定する。all を使わないこと。

summary 特定のキュー名のキュープロパティを表示する。特定の<キュー名>あるいは all を指定する。

diagevent の使用例

diagevent summary all — 全てのキューのプロパティを表示する。

diagevent drop <queue name> 100 — 定義されたキューからトップ 100 イベントをドロップする。

2–6 DocuShare Command Line Utilities Guide

Page 19: DocuShare コマンドラインユーティリティガイド

DocuShare Commands diaggovernor

diaggovernor

構文:diaggovernor

diaggovernor コマンドは、DocuShare サーバー統計のコマンドの統計テーブルに示される情報を表示する。このコマンドは、DocuShare サイト

がフリーズしたように見え、サーバー統計の UI ページが表示できないときに便利な診断ツールである。

diaggovernor の出力

Blocked Command Report ブロックされたコマンドの履歴とコマンドがブロックされた理由。

Waiting Commands 実行待ちのコマンド。

Running Commands 実行中のコマンド。

Active UI User Sessions web ブラウザーなどの参加されたアプリケーションを操作しているユーザーの代わりに起動されたアクティ

ブなユーザーセッション。CIM ingestion やバックグラウンドジョブなどの参加されていないアプリケーション

は、表示されない。

DocuShare Command Line Utilities Guide 2-7

Page 20: DocuShare コマンドラインユーティリティガイド

dscli DocuShare Commands

dscli

構文: dscli

dscli コマンドにより、dsimport、dsexport、dsdelete、dslistprop、dsgetprop、dssetprop、dslock、dsunlock、dstrashcan、

dsorphan、および dsservice コマンドなど、これらすべてのコマンドのヘルプページが表示される。

2–8 DocuShare Command Line Utilities Guide

Page 21: DocuShare コマンドラインユーティリティガイド

DocuShare Commands dsdelete

dsdelete

構文:dsdelete [オプション] ハンドル

dsdelete コマンドは、サイトオブジェクトを削除する。

dsdelete のオプション

-h ヘルプ。コマンドのヘルプを表示する。

-l レベル。ログファイルに指定のメッセージレベル(debug、trace、info、warn、error、fatal)を書き込む。

-o 所有物の処分。User オブジェクトを削除する場合は、その時点でそのユーザーが所有するすべてのコ

ンテンツは、削除するか、または新しい所有者に譲渡する必要がある。デフォルトでは、ユーザーがその

時点で所有するすべてのコンテンツは削除される。-o user-handle を指定すると、削除されるユーザ

ーがその時点で所有するすべてのオブジェクトの所有権が、user-handle に譲渡される。

以下に、例を示す。dsdelete -o User-40 User-21

この例では、User-21 が所有するすべてのオブジェクトの所有権を User-40 に譲渡してから、User-

21 を削除する。

-q Quiet。コマンドを Quiet モードで実行する。すべての情報メッセージと、ユーザーによる「はい」または

「いいえ」の入力を促すプロンプトの表示を抑制する。すべてのプロンプトに対して、「はい」が入力され

たものとみなされる。その実行結果についてはユーザーの責任となる。

-u ユーザー。指定されたユーザーの権限でコマンドを実行する。引数としてユーザーハンドルが必要であ

る。デフォルトでは、すべてのコマンドを adim ユーザーの権限で実行する。これにより、コマンドにはすべ

ての権限が与えられ、また、コマンドが実行するすべての編集操作の実行者は、admin となる。例えば、

-u User-12 と指定すると、コマンドは admin ではなく、User-12 の権限で実行される。

-w Walker。dsdelete の操作を、リポジトリを変更せずにシミュレーション実行し、操作によって影響を受け

るオブジェクトの一覧を表示する。

-x 抹消。ごみ箱が有効であるかどうかにかかわらず、オブジェクトを DocuShare サイトから永久に削除す

る。このオプションでは、1 つのコマンドラインに、10 個以上の引数を指定することができる。各オブジェク

トハンドルは、スペースで区切って並べる。

dsdelete の使用例

dsdelete handle — ごみ箱が有効である場合は、オブジェクトをごみ箱に移動する。ごみ箱が有効でない場合は、オブジェクト

は完全に削除される。

dsdelete -x handle — ごみ箱が有効であるかどうかにかかわらず、オブジェクトを DocuShare サイトから完全に削除する。 1

回の操作で複数のオブジェクトを削除する場合は、複数のハンドルをスペースで区切って指定する。 以下に、例を示す。

dsdelete -x -q -l trace URL-11 URL-12 URL-13 URL-14 URL-15 URL-16 URL-17 URL-18 URL-19 URL-20 URL-

21 URL-22

DocuShare Command Line Utilities Guide 2–9

Page 22: DocuShare コマンドラインユーティリティガイド

dsexport DocuShare Commands

dsexport 構文:dsexport [オプション] ハンドルまたはクラス名

注:DocuShare アーカイブサーバーでの使用はサポートされていない。

dsexport コマンドは、デフォルトでは、サイトオブジェクトを XML 形式のファイルにエクスポートする。 CSV 形式のファイルにエクスポートするに

は、-f オプションを指定する。その結果得られたファイルは、別の DocuShare サーバーにおける dsimport の入力事項として、あるいは他のデ

スティネーションへの入力事項として使用することができる。情報を出力しても、そのオブジェクトが DocuShare リポジトリから削除されることは

ない。

他の多くの DocuShare コマンドとは異なり、dsexport では、特定のオブジェクトまたはオブジェクトクラス全体を指定することができる。

Dsexport は、特定のスペースをエクスポートできるが、スペースクラス名全体はできない。オブジェクトハンドルまたはクラス名は、エクスポートさ

れる DocuShare リポジトリ内のオブジェクトのハンドルか、または、DocuShare オブジェクトクラスの名前(Collection、 Document、User など)

である。クラス名を指定した場合は、そのクラスのすべてのリポジトリオブジェクトを出力する。スペースで区切ることにより、複数のハンドルまたは

クラス名を指定することができる。

注:User-1、User-2、Group-1、レンディション、通知、バージョンなどのシステムオブジェクトを、エクスポートすることはできない。レンデ

ィションとバージョンは、単独でエクスポートすることはできない。しかし、ドキュメントオブジェクトの一部としてエクスポートすることはできる。

dsexport のオプション

-c 正規表現マッチングをサポートする。条件ファイルではワイルドカード文字は使用できない。条件付きの

ファイルの中で日付特性を指定する場合、3/9/09 ではなく 03/09/2009 でのように、フォーマット

mm/dd/yyyy を使用する。

-d 出力先。dsexport の出力を格納するディレクトリを指定する。デフォルトの出力先は、その時点におけ

る作業ディレクトリとなる。dsexport は、出力先ディレクトリに、抽出するハンドルと同一名のディレクト

リを作成する。次にそのディレクトリの中に、handle.xml という名前の XML ファイルと、documents とい

う名前のディレクトリを作成する。抽出されたドキュメント(ドキュメントオブジェクトに関連する、元のエン

ドユーザードキュメント)はすべて、 終的に documents ディレクトリに格納される。

-e 符号化。出力ファイルの文字コードを指定する。デフォルトでは UTF-8 となる。

-f Force。強制的に CSV 形式でエクスポートする。

-g グループ。グループをエクスポートする場合は、そのグループの下に属するグループやユーザーも再帰的

にエクスポートする。-g オプションを指定しない場合は、エクスポート対象オブジェクトの ACL に明示さ

れているグループのみをエクスポートする。

-h ヘルプ。コマンドのヘルプを表示する。

-l レベル。ログファイルに指定レベル(debug、trace、info、warn、error、fatal)のメッセージを書き込む。

-m メタデータのみ。ドキュメントオブジェクトをエクスポートする際に、そのメタデータ(プロパティ)のみをエクス

ポートする。ドキュメント自体はエクスポートされない。

2-10 DocuShare Command Line Utilities Guide

Page 23: DocuShare コマンドラインユーティリティガイド

DocuShare Commands dsexport

-p プロパティ。エクスポートするデータに含めるプロパティを指定する。

プロパティを指定しない場合は、各オブジェクトのすべてのプロパティがエクスポートされる。1 つ以上のプ

ロパティオプションを指定した場合は、それらのプロパティのみがエクスポートされる。1 つのコマンドライン

には、-p を 1 つだけ記述し、プロパティ名の間をカンマで区切る。オブジェクトのハンドルは常にエクスポ

ートされる。ユーザーオブジェクトのドメインとユーザー名も常にエクスポートされる。

-q Quiet。コマンドを Quiet モードで実行する。すべての情報メッセージと、ユーザーによる「はい」または

「いいえ」の入力を促すプロンプトの表示を抑制する。すべてのプロンプトに対して、「はい」が入力され

たものとみなされる。その実行結果についてはユーザーの責任となる。

-r 再帰。ハンドルから参照可能なすべてのオブジェクトを再帰的に出力する。これには、アクセス権設定

におけるユーザーのリストや、ハンドル内に含まれるオブジェクトも含まれる。包含する階層内のみをたど

る。親リンクをさかのぼることはしない。–r オプションを指定しない場合は、ハンドルで指定されたオブジェ

クトのみを出力する。ハンドルまたはクラス名として、クラス名が指定されている場合は、–r オプションは

無効となる。

-s 通知。通知のエクスポートが可能になる。

-t スレッド。 大スレッド数を指定する。デフォルトでは、マルチスレッドのエクスポート機能は無効となって

いる。2 から 20 の間の整数を設定すると、マルチスレッドのエクスポート機能が有効となる。

注: 大スレッド数は 20 である。20 以上の数値を指定した場合は、20 が適用される。

-u ユーザー。コマンドを指定されたユーザーの権限で実行する。引数としてユーザーハンドルが必要であ

る。デフォルトでは、すべてのコマンドを admin ユーザーの権限で実行する。これにより、コマンドにはす

べての権限が与えられ、また、コマンドが実行するすべての編集操作の実行者は、admin となる。例え

ば、-u User-12 と指定すると、コマンドは admin ではなく、User-12 の権限で実行される。

dsexport の使用例

dsexport -r -d \export Collection-141 - Collection-141 とそのすべてのコンテンツを XML にエクスポートする。

以下のファイルがエクスポートされる。

D:\export\Collection-141\Collection-141.xml

D:\export\Collection-141\documents

D:\export\Collection-141\documents\Rendition-11_2.29 other r.02.doc

D:\export\Collection-141\documents\Rendition-12_2.19.doc

D:\export\Collection-141\documents\Rendition-13_2.20.doc

D:\export\Collection-141\documents\Rendition-14_2.22.doc

D:\export\Collection-141\documents\Rendition-15_2.23.doc

D:\export\Collection-141\documents\Rendition-16_2.26 R02.doc

D:\export\Collection-141\documents\Rendition-17_2.26.doc

D:\export\Collection-141\documents\Rendition-18_2.29 imari r0.2.doc

D:\export\Collection-141\documents\Rendition-19_2.29 imari.doc

D:\export\Collection-141\documents\Rendition-20_2.19 R02.doc

DocuShare Command Line Utilities Guide 2–11

Page 24: DocuShare コマンドラインユーティリティガイド

dsexport DocuShare Commands

コレクション内の特定のファイルをエクスポートする。

Strong test という名前の Collection-X に、e-HongKong サイトという名前の URL、khong guan biscuit という名前の

Collection-Y、test という名前のドキュメントが含まれているものとする。

a. title = .*ong.*という行を含む cond.txt という名前のファイルを作成する。

b. コマンドラインにおいて、dsexport -c cond.txt -r Collection-X を実行する。

この場合、タイトルに ong を含むオブジェクトのみがエクスポートされる。つまり、Strong test コレクション、e-HongKong サ

イト URL、および khong guan biscuit のみがエクスポートされる。

test ドキュメントはエクスポートされない。

c. title = .*[h|H]ong.*という行を含む cond2.txt という名前のファイルを作成する。

d. コマンドラインにおいて、dsexport -c cond2.txt -r Collection-X を実行する。

この場合は、タイトルに hong または Hong を含むオブジェクトのみがエクスポートされる。つまり、e-HongKong サイト URL

と khong guan biscuit のみがエクスポートされる。

test ドキュメントと Strong test コレクションはエクスポートされない。

dsexport と-t オプションの使用例

a. dsexport で、20 個のスレッドをフォークして Collection-10 のツリーをエクスポートする。これにより、エクスポート時間が約

20%短縮されることになる。

dsexport -r -t 20 Collection-10

b. Dsexport では、スレッドを使用せずに Collection-10 のツリーがエクスポートされる。この操作は、dsexport -r

Collection-10 と同じである。

dsexport -r -t 0 Collection-10

dsexport とスペースの使用例

a. Space-11 オブジェクトと、このスペースのメンバーシップグループをエクスポートするには、次のよう

に入力する。

dsexport Space-11

b. Space-11 のワークスペースは含み、Space-11 の孤立オブジェクトは除いて、Space-11 オブジェクトとそのコンテンツをエ

クスポートするには、次のように入力する。

dsexport –r Space-11

CSV ファイルエクスポートの例

dsexport -f csv Document - 強制的に CSV ファイルでエクスポートする。エクスポートする CSV ファイルに ISO-8859-1 以外の

文字セットが含まれていない場合は、その CSV ファイルを任意のテキストエディタで編集することができる。エクスポートする CSV ファ

イルに unicode 文字が含まれる場合は、unicode をサポートするテキストエディタでその CSV ファイルを編集する必要がある。この

編集作業を行わないと、CSV ファイル内の unicode 文字が、ファイル保存後に?に変換されてしまう可能性がある。

dsexport -e Shift_JIS -f csv Collection-10 - Collection-10 を Shift_JIS を用いて CSV ファイルにエクスポートする

2–12 DocuShare Command Line Utilities Guide

Page 25: DocuShare コマンドラインユーティリティガイド

DocuShare Commands dsexport

dsexport の動作について

dsexport コマンドは、リポジトリデータを解析し、それをポータブルなテキストベースの表現に変換する必要がある。本節では、特

殊な動作上の条件について説明する。

複数の親を持つオブジェクト

例えば Collection-n をエクスポートする場合、親リンクはエクスポートされない。Collection-m が、Collection-n と Collection-z

(Collection-n のツリーには含まれていないものとする)の両方に含まれている場合、Collection-m とともに、Collection-n および

Collection-z へのソースリンク参照がエクスポートされる。Collection-z は、操作の対象外であり、エクスポートされない。

ゲストアカウントと管理者アカウント

ゲストおよび管理者アカウントをエクスポートする場合は、そのユーザー名プロパティのみがエクスポートされる。この制約は、セキュリティ上の

対策として課せられています。ゲストと管理者のユーザー名は、リポジトリにおけるその時点のユーザー名とは関係なく、それぞれ必ず

「Guest」および「admin」としてエクスポートされる。これは、dsimport やその他のツールでこれらのアカウントを正しく認識できるようにするため

である。

CSV へのエクスポート

• dsexport は、各オブジェクトの単一のバージョンをエクスポートする。ドキュメントに複数のバージョンが存在する場合は、推奨バージ

ョンとして指定されているバージョンが CSV にエクスポートされる。

• dsexport は、ACL をエクスポートしない。CSV にエクスポートしたオブジェクトを、dsimport を用いてインポートする際には、新たにイ

ンポートする場所による新しい ACL、または dsimport 操作が場所に関係しない場合はデフォルトの ACL がそのオブジェクトに割り

当てられる。

XML へのエクスポート

• すべてのドキュメントバージョンが XML にエクスポートされる。

• ACL も XML にエクスポートされる。

DocuShare Command Line Utilities Guide 2–13

Page 26: DocuShare コマンドラインユーティリティガイド

dsgetprop DocuShare Commands

dsgetprop

構文:dsgetprop [オプション] [サーバー | ハンドル] プロパティスペック

dslistprop [オプション] [サーバー | ハンドル]

dssetprop [オプション] [サーバー | ハンドル] プロパティ値

管理者は、3 つの DocuShare プロパティコマンドを使用して、任意の DocuShare DSClass、オブジェクト、オブジェクトのプロパティ値を参

照することができる。

• dsgetprop コマンドは、指定されたプロパティの現在の値を返す。パスワードに関連するプロパティが返されることはない。

• dslistprop コマンドは、DocuShare データベース内でハンドルを検索し、そのハンドルに関連するすべての読み取り可能なプロパティ

の名前の一覧を返する。クラス名のプロパティ一覧を取得するには、dslistprop <file>を使用する。

• dssetprop コマンドは、指定されたプロパティの現在の値を、指定された値に変更する。パスワードに関連するプロパティは除外され

る。

これらのコマンドでは、第一引数として、Collection-10 や User-23 などの DocuShare ハンドルが必要である。指定されたハンドルまたはプロ

パティが DocuShare データベースに見つからなかった場合は、コマンドはハンドルまたはプロパティが見つからなかったことを示すメッセージを表

示し、ステータス-1 で終了する。

dsgetprop のオプション

-h ヘルプ。コマンドのヘルプを表示する。

-l レベル。ログファイルに指定レベル(debug、trace、info、warn、error、fatal)のメッセージを書き込む。

-q Quiet。コマンドを Quiet モードで実行する。すべての情報メッセージと、ユーザーによる「はい」または

「いいえ」の入力を促すプロンプトの表示を抑制する。すべてのプロンプトに対して、「はい」が入力され

たものとみなされる。その実行結果についてはユーザーの責任となる。

-u ユーザー。dsgetprop および dssetprop のみに適用される。コマンドを指定されたユーザーの権限で実

行する。引数としてユーザーハンドルが必要である。デフォルトでは、すべてのコマンドを adim ユーザー

の権限で実行する。これにより、コマンドにはすべての権限が与えられ、また、コマンドが実行するすべ

ての編集操作の実行者は、admin となる。例えば、-u User-12 と指定すると、コマンドは admin で

はなく、User-12 の権限で実行される。

dsgetprop の使用例

注:引数に複数のプロパティが指定されている場合、-q オプションは無効となる。

dsgetprop -q Document-11 summary - ドキュメントのサマリーと所有者を表示する。

dsgetprop Server adminEmail - サイトの admin の電子メールを表示する。

dsgetprop Server - サイトのプロパティとその値を表示する。

2-14 DocuShare Command Line Utilities Guide

Page 27: DocuShare コマンドラインユーティリティガイド

DocuShare Commands dslistprop

dslistprop

構文:dslistprop [オプション] [サーバー | ハンドル] dsgetprop [オプション]

[サーバー | ハンドル] プロパティスペック dssetprop [オプション] [サーバー |

ハンドル] プロパティ値 値

管理者は、3 つの DocuShare プロパティコマンドを使用して、任意の DocuShare DSClass、オブジェクト、オブジェクトのプロパティ値を参

照することができる。

• dslistprop コマンドは、DocuShare データベース内でハンドルを検索し、そのハンドルに関連するすべての読み取り可能なプロパティ

の名前の一覧を返す。クラス名のプロパティ一覧を取得するには、dslistprop <file>を使用する。

• dsgetprop コマンドは、指定されたプロパティの現在の値を返す。パスワードに関連するプロパティが返されることはない。

• dssetprop コマンドは、指定されたプロパティの現在値を、指定の値に変更する。パスワードに関連するプロパティが変更されること

はない。

これらのコマンドには、第一引数として、Collection-10 や User-23 などの DocuShare ハンドルが必要である。指定されたハンドルまたはプロ

パティが DocuShare データベースに見つからなかった場合は、コマンドはハンドルまたはプロパティが見つからなかったことを示すメッセージを表

示し、ステータス-1 でこのコマンドを終了する。

dslistprop のオプション

-h ヘルプ。コマンドのヘルプを表示す。

-l レベル。ログファイルに指定レベル(debug、trace、info、warn、error、fatal)のメッセージを書き込む。

-q Quiet。コマンドを Quiet モードで実行する。すべての情報メッセージと、ユーザーによる「はい」または

「いいえ」の入力を促すプロンプトの表示を抑制する。すべてのプロンプトに対して、「はい」が入力され

たものとみなされる。その実行結果についてはユーザーの責任となる。

dslistprop の使用例

dslistprop server - サイトのすべてのプロパティを一覧表示する。

DocuShare Command Line Utilities Guide 2–15

Page 28: DocuShare コマンドラインユーティリティガイド

dssetprop DocuShare Commands

dssetprop

構文:dssetprop [オプション] [サーバー | ハンドル] プロパティ値

dsgetprop [オプション] [サーバー | ハンドル] プロパティスペック

dslistprop [オプション] [サーバー | ハンドル]

管理者は、3 つの DocuShare プロパティコマンドを使用して、任意の DocuShare DSClass、オブジェクト、オブジェクトのプロパティ値を参

照することができる。

• dssetprop コマンドは、指定されたプロパティの現在値を、指定の値に変更する。パスワードに関連するプロパティが変更されること

はない。

• dsgetprop コマンドは、指定されたプロパティの現在の値を返す。パスワードに関連するプロパティが返されることはない。

• dslistprop コマンドは、DocuShare データベース内でハンドルを検索し、そのハンドルに関連するすべての読み取り可能なプロパティ

の名前の一覧を返す。クラス名のプロパティ一覧を取得するには、dslistprop <file>を使用する。

これらのコマンドでは、第一引数として、Collection-10 や User-23 などの DocuShare ハンドルが必要である。指定されたハンドルまたはプロ

パティが DocuShare データベースに見つからなかった場合は、コマンドはハンドルまたはプロパティが見つからなかったことを示すメッセージを表

示し、ステータス-1 でこのコマンドを終了する。

dssetprop のオプション

-append 親プロパティに対して使用し、現在の親リストに追加する。replace と append の両方のオプションが有

効である場合は、append オプションが適用される。-q が指定されている場合は、replace が有効でな

い限り、デフォルトで append オプションが有効となる。

-h ヘルプ。コマンドの使用方法に関する情報を出力する。

-replace 親プロパティに対して使用され、既存の親を置き換える。

-l レベル。ログファイルに指定レベル(debug、trace、info、warn、error、fatal)のメッセージを書き込む。

-q Quiet。コマンドを Quiet モードで実行する。すべての情報メッセージと、ユーザーによる「はい」または

「いいえ」の入力を促すプロンプトの表示を抑制する。すべてのプロンプトに対して、「はい」が入力され

たものとみなされる。その実行結果についてはユーザーの責任となる。

「はい」または「いいえ」の入力を促すプロンプトの例:既存の親と置き換えるか、それとも親リストに追加

するか?

-u ユーザー。dsgetprop および dssetprop のみに適用される。ユーザーオブジェクトハンドルで指定された

ユーザーとしてコマンドを実行する。デフォルトでは、すべてのコマンドを adim ユーザーの権限で実行す

る。これにより、コマンドにはすべての権限が与えられ、また、コマンドが実行するすべての編集操作の

実行者は、admin となる。例えば、-u User-12 と指定すると、コマンドは admin ではなく、User-12

の権限で実行される。

2–16 DocuShare Command Line Utilities Guide

Page 29: DocuShare コマンドラインユーティリティガイド

DocuShare Commands dssetprop

dssetprop の使用例

dssetprop Document-11 title "Sales Results" - Document-11 のタイトルを「Sales Results」と設定する。

dssetprop -append Document-11 parents Collection-11,Collection-12 - Document-11 を Collection-12、Collection-12 に追

加する。

dssetprop -replace Document-11 parents Collection-13 - Document-11 を親コレクションから削除し、Collection-13 のみに属す

るようにする。

dssetprop URL-11 custom_date “11/05/04 8:14 PM” - オブジェクト URL-11 にカスタマイズされた日付を設定する

dssetprop URL-11 expiration_date “11/05/04 8:14 PM” - オブジェクト URL-11 に有効期限を設定する

dssetprop serverEmail [email protected] - サイトの admin の電子メールを [email protected] と設定する

DocuShare Command Line Utilities Guide 2–17

Page 30: DocuShare コマンドラインユーティリティガイド

Server properties DocuShare Commands

サーバープロパティ

構文:dslistprop [オプション] Server

dsgetprop [オプション] Server プロパティスペック

dssetprop [オプション] Server プロパティ値

サーバープロパティは、dsgetprop および dssetprop に適用され、サーバー構成データベースの属性へのアクセスを提供する。現在サポートさ

れているサーバープロパティと、それに関連する[プロパティのカテゴリ]の概略を表 2–2 に示す。すべてのサーバープロパティを参照するには、

dslistprop Server を実行してください。

表 2-2:サーバープロパティ

サーバープロパティ 定義 access_log <パス名> access.csv ファイルのパス名。DocuShare の再起動が必要

となる。 access_log_max_size <整数> Access Log ファイルに割り当てられた 大バイト数。 accountAuthority <ゲスト、ユーザー、 アカウントを作成可能なユーザーを指定する。

新規ユーザーまたは admin>

admin_message <文字列> サイトに表示されるメッセージテキスト。

adminEmail <電子メールアドレス> 通知管理者として指名されているユーザーの電子メールアド

レス。 background <パス名> すべての DocuShare ページの背景画像である JPEG また

は GIF 画像ファイルのパス名。 bgcolor <16 進数色番号> すべての DocuShare ページに対する背景色の 16 進コード。

デフォルトの背景色は、#FFFFFF(白)である。 buildLinux 読み取り専用。DocuShare の Linux 版のソフトウェアビルド

番号。

buildSolaris 読み取り専用。DocuShare の Solaris 版のソフトウェアビル

ド番号。

buildWin32 読み取り専用。DocuShare の Windows 版のソフトウェアビ

ルド番号。

database <文字列> 読み取り専用。ファイルストレージとして使用するデータベー

スの名前。 doc_base <パス名> 読み取り専用。現在の DocuShare サイトのルート。デフォル

トは、/DocuShare/である。 driver <文字列> 読み取り専用。JDBC ドライバのフルクラス名。 ds22Cookies <true または false> DocuShare 6 サイトにおいて DS 2.2 cookie をサポートさせ

る場合は true、サポートさせない場合は false を指定する。

dynamic_update_of_modified_vdf

<1 または 0>

2–18 DocuShare Command Line Utilities Guide

VDF の表示速度を制御する。値が 1 の場合、DocuShare

に対し VDF ファイルを動的に更新するように指示する。値が

0 の場合、DocuShare に対し、要求された VDF ファイルがキ

ャッシュに存在しない場合は、ファイルシステムをチェックするよ

うに指示する。また、ファイルシステムにおける VDF の更新日

がキャッシュに現在存在するものよりも新しい場合は、キャッシ

ュを更新しないように指示する。

Page 31: DocuShare コマンドラインユーティリティガイド

DocuShare Commands Server properties

表 2-2:サーバープロパティ

サーバープロパティ 定義

enable_htmlview <1 または 0> 値が 1 の場合は、特定のドキュメントの HTML への変換を有

効にする。

enable_javascript <1 または 0> 値が 1 の場合は、DocuShare フォームにおける JavaScript の

使用を有効にする。

enable_log <1 または 0> アクセスログとエラーログの有効化または無効化を設定する。

enable_persistent_login <1 または 0> 値が 1 の場合は、永続ログインを有効にする。

enable_remote_user <1 または 0> 値が 1 の場合は、Windows ドメイン認証による DocuShare ロ

グイン認証を有効にする。

enable_routing <1 または 0> 値が 1 の場合は、ルーティングシステムが起動され、

DocuShare はルーティングアイコンをサイトユーザーに対して表

示する。

enable_thumbnail <1 または 0> 値が 1 の場合は、画像ファイルに対するサムネイルビューの作

成を有効にする。

enableSubscriptions <true または false> 値が true の場合は、通知サービスを有効にする。

error_log <パス名> error.csv ファイルのパス名。DocuShare の再起動が必要とな

る。

error_log_max_size <整数> Error Log ファイルに割り当てられた 大バイト数。

http_host <文字列> 読み取り専用。現在 DocuShare がインストールされているサ

ーバーのホスト名。この値は、インストール時に設定したホスト

名であり、DocuShare が生成するすべての URL で使用される。

http_port <整数> 読み取り専用。DocuShare Tomcat ウェブサーバーが使用す

るポート番号。デフォルトのポート番号は、8080 である。

http_protocol <http または https> 読み取り専用。DocuShare サーバー用のプロトコルを指定す

る。デフォルトは http である。

image_base <画像ファイルフォルダへのパス名> 読み取り専用。DocuShare 画像ディレクトリへの URL パス。デ

フォルトのインストールでは通常、/images /と同一となる。

license_generator_URL 読み取り専用。[サイト管理/ライセンス]ページにおいて、試

用ライセンスまたは認可サイトライセンスを取得するためにフォー

ムを作成する際に、admin が参照する URL。

linkChunkSize <整数> 1 つの SQL シーケンスにおいて生成可能な 大ハンドル数。

locale_default <文字列> 読み取り専用。Autonomy アプリケーションがドキュメントのイン

デックス作成に使用するデフォルトのロケール設定。

logging_level <debug、trace、info、warn、 Amber システムのログ記録レベル。

error、lethal、または fatal>

logLevel <debug、trace、info、warn、error、 database_JDBC のログ記録レベル。

lethal、または fatal>

DocuShare Command Line Utilities Guide 2–19

Page 32: DocuShare コマンドラインユーティリティガイド

Server properties DocuShare Commands

表 2-2:サーバープロパティ

サーバープロパティ 定義 mail_list_delimiter <; または ,> Mail To コマンドを用いて電子メールメッセージを複数の受

信者に送信する際の、送信先フィールドの電子メールアドレ

スの区切りとして使用する、セミコロンまたはカンマの区切り

文字。

new_cache <整数> サイトの「NEW」アイコンの期間プロパティを制御する。

有効な設定値:0 = 表示しない

1 = 1 日

2 = 2 日

3 = 3 日

4 = 4 日

5 = 5 日 7 = 1 週間 14 = 2 週間 30 = 1 ヶ月

pagesize <整数> DocuShare 6 には実装されていない。コレクション内の一覧

表示数を制御する。 patchesInstalled 読み取り専用。サイトに現在インストールされているソフトウェ

アパッチ。

poolSize <整数> JDBC 接続プールのサイズ。

providerName <文字列> 読み取り専用。データベースプロバイダのファイル名(SQL

Server のみ)。デフォルトは MSDE である。

registry_access <ゲスト、ユーザー、 サイトレジストリにアクセス可能なユーザーを指定する。

または admin>

searchResultChunkSize <整数> データベースから取得する検索結果の 大数。 show_msg <1 または 0> admin_message に入力された管理用メッセージを、

DocuShare サイトに表示するかどうかを指定する。値が 1 の場

合は、メッセージを表示する。

siteAccess <ゲスト、ユーザー、または admin> サイトにアクセス可能なユーザーを指定する。

siteName <文字列> DocuShare サイト名。

sleepTime <整数> JDBC 接続プール作成までの待ち時間(単位:ミリ秒)。 temp_directory <パス名> サイトの一時ディレクトリのパス名。

2–20 DocuShare Command Line Utilities Guide

Page 33: DocuShare コマンドラインユーティリティガイド

DocuShare Commands Server properties

表 2-2:サーバープロパティ

サーバープロパティ 定義 trashExpiration <整数> サイトゴミ箱に保存しておく期間を設定する。

期間を過ぎたものは永久に削除され復元不可能になる。

有効な値:0 = 保存しない

1 = 1 時間

24 = 1 日 72 = 3 日 168 = 1 週間 720 = 30 日 2000 = 2 ヶ

3000 = 3 ヶ月 6000 = 6 ヶ月

url <パス名> データベースの JDBC URL アドレス。

use_external_server <1 または 0> 読み取り専用。値が 1 の場合は、Docushare サーバーは、

(Tomcat 上で稼働する)Web Application Server と同一の

JVM インスタンス内で稼働する必要がある。値が 0 の場合は、

Docushare サーバーは、Web Application Server とは別の

JVM インスタンス内で稼働しなければならない。 waitMS <整数> クエリがタイムアウトするまでの待ち時間(単位:ミリ秒)。

dslistprop、dsgetprop、および dssetprop の使用例

dslistprop Collection-10 - Collection-10 の使用可能なプロパティを一覧表示する

dsgetprop Collection-10 title - Collection-10 のタイトルを参照する

dssetprop User-27 budget_center BC7739 - User-27 の予算センター(budget center)を BC7739 と設定する

dssetprop Server admin_msg "The server will be going down at 5:00pm." - 管理メッセージを変更する

dssetprop Server siteAccess admin - サイトへのアクセスを管理者のみに限定する

DocuShare Command Line Utilities Guide 2–21

Page 34: DocuShare コマンドラインユーティリティガイド

dsimport DocuShare Commands

dsimport

構文:dsimport [オプション] <操作> ファイル名

注:このコマンドは、DocuShare アーカイブサーバーでの使用はサポートされていない。このコマンドは、インポートされたオブジェクトの所有者を

変更するために使用することはできない。

dsimport コマンドは、新しいサイトオブジェクトの DocuShare リポジトリへの大量挿入や、admin による既存のオブジェクトの更新を可能とする。

この操作を使用する例としては、ある DocuShare サーバーから別の DocuShare サーバーへとコレクションツリーを移動する場合や、別のアプリ

ケーションで収集した、ユーザーアカウントや大容量のスキャン済みドキュメントなどのデータを既存オブジェクトへと挿入する場合が挙げられる。

<ファイル名>引数には、エクスポートされたファイルのパスを指定する。このコマンドは、ファイルを、それがエクスポートされた形式(XML または

CSV)で自動的にインポートする。

admin アカウントなど、システムリソースオブジェクトを変更しようとする操作は、サーバーのセキュリティ上の観点から無効となる。Quiet オプショ

ンが指定されていない場合は、システムリソースオブジェクトが現れると、警告メッセージが出力される。

<ファイル名>の中で定義されたオブジェクトのいずれかの type が Document で、import 操作によりそのオブジェクトのドキュメントまたはバージ

ョンプロパティが更新される場合、ファイル名と同じディレクトリ内の Documents ディレクトリに、そのオブジェクトのドキュメントが存在していなけ

ればならない。ドキュメントプロパティは、すべての add および replace 操作と、オブジェクトのドキュメントフィールドを指定した modify 操作で

更新される。Documents ディレクトリ内のファイルは、以下の規則に従ってオブジェクト定義と 1 対 1 に対応している。

1. ハンドル H が Rendition オブジェクトとして宣言されている場合、H_xxx という名前のファイルを検索する。ここで xxx は、0 から始まる

整数である。

2. 入力される XML が以前の DocuShare バージョンからのものである場合、H_yyy という名前のファイルを検索する。ここで yyy は、元

のファイル名である。

3. オブジェクトのドキュメントプロパティが値 D で定義されている場合、D.1 という名前のファイルを検索する。

4. オブジェクトのドキュメントプロパティが値 D で定義されている場合、D という名前のファイルを検索する。

注:大量のファイルをインポートすると、不要な通知メールを発生させることがある。詳細は、「大量オブジェクトのインポート」を参照する。

レジューム機能

インポートファイルの一部に形式の不具合があるために、dsimport がエラー終了する場合は、入力 XML と同じディレクトリにダンプファイルが

生成される。入力 XML のファイル名が Document-11.xml である場合は、ダンプファイル名は Document-11.xml.dmp となる。レジュームダン

プファイルを削除すると、dsimport は、オブジェクトが事前にインポートされるものとして処理を開始する。インポートファイルの問題を修正した

後、同じ dsimport コマンドを再度実行すると、失敗した箇所からインポートを再開する。

レジューム機能にはオプションはない。レジューム機能はデフォルトで有効となっている。レジューム機能を無効にするには、-f(force)オプシ

ョンを指定する。

dsimport のレジュームの例

dsimport add Document\Document.xml が、Document-456 の処理に失敗した場合、インポートファイルを編集して Document-456 のエ

ントリの誤りを修正する。DocuShare 管理者は、同じコマンドを再入力することにより、Document-456 のエントリからインポートを再開するこ

とができる。

2–22 DocuShare Command Line Utilities Guide

※注:DS6.6では通知サービスの停止(dsservice stop Notification)ができません。

Page 35: DocuShare コマンドラインユーティリティガイド

DocuShare Commands dsimport

dsimport のオプション

-a 単一のオブジェクトを 1 度に 1 つずつインポートする。

このオプションを使用することにより、ユーザーは大容量のインポート実行中の、RMI エラー、Message

Queue のあふれ、その他の関連する問題を回避できる。

このオプションがオンになっている場合、dsimport はインポートディレクトリの下の resume.dmp ファイル

をチェックする(1 つ前のインポート段階のハンドルマッピングダンプファイル)。resume.dmp ファイルでは、

すべての個別のインポート処理が、1 つの大容量インポートにリンクされている。

• ファイルが見つからなかった場合、警告メッセージが表示され、resume.dmp ファイルなしでオブジェクト

のインポートを続行するかどうかをユーザーに確認するプロンプトが出される。ユーザーは警告を無視し

てインポート操作を続行することができる。

• ファイルが見つかった場合、前のハンドルマッピング情報をロードし、現在の XML ファイルのインポート

を続行する。

-d 出力先。インポートするオブジェクトを格納するレジストリコンテナオブジェクトを指定する。ほとんどの場

合、これは Collection ハンドルとなる。入力オブジェクト定義ファイルには、ある種の内部構造を持つオ

ブジェクトの集合が定義されています。構造は、フラットなリスト構造である場合もあれば、完全な包含

関係が成立する階層構造である場合もある。親が宣言されていないインポートオブジェクトのデフォル

トの出力先は、孤立オブジェクトと同じ一般的なリポジトリスペースとなる。出力先コンテナオブジェクト

が指定されている場合は、インポートファイル内の親を持たないオブジェクトはすべて、出力先コンテナ

オブジェクトに格納される。

-f 強制。インポートされるオブジェクトが存在しない別のオブジェクトを参照している場合、dsimport は問

題となっている参照先を削除してオブジェクトのインポートを試みる。

リストの問題となっているオブジェクトの参照先(例えば親や子に対する参照など)は削除される。

ユーザに対する単一の参照(所有者や変更者など)は、dsimport ユーザーとして設定される。(デフォ

ルトでは admin:-u を参照のこと。)

-h ヘルプ。コマンドのヘルプを表示する。

-i 単一オブジェクトのインポート。指定された 1 つのオブジェクトのみをインポートする。dsimport は、他の

すべてのオブジェクトをスキップする。

-l レベル。ログファイルに指定レベル(debug、trace、info、warn、error、fatal)のメッセージを書き込む

DocuShare Command Line Utilities Guide 2–23

Page 36: DocuShare コマンドラインユーティリティガイド

dsimport DocuShare Commands

-n ユーザーまたはグループ名認識。

ユーザー名認識は、インポートするユーザーのユーザー名が、既存のリポジトリユーザーと同一であった

場合の add 操作の動作を変更するために使用する。デフォルトでは add 操作は、すべてのインポート

オブジェクトは、新規で一意に識別可能なオブジェクトであるものとみなす。

インポートするユーザーに既存のリポジトリユーザーと同一のユーザー名が指定されている場合、エラー

が表示される。-n use を指定すると、同一のユーザー名が見つかった場合に既存のリポジトリユーザー

を使用する。この場合、インポートユーザーは、インポートファイル内における参照としてのみ使用され、

dsimport はそのユーザー名への参照をすべて、一致した既存のリポジトリユーザーにマッピングする。こ

のオプションは、新規オブジェクトを既存ユーザーの所有オブジェクトとして追加する場合に、 も適して

います。-n must_exist を指定すると、デフォルトの add 操作の動作とは逆に、インポートするユーザー

オブジェクトが既存のリポジトリユーザーと一致しない場合にエラーを表示する。-n オプションを使用す

る場合は、「-n user」、「-n must_exist」などのように、必ずオプションの値を指定する必要がある。

グループ名認識は、インポートするグループのグループタイトルおよび所有者ユーザー名が、既存のリポ

ジトリグループと同一であった場合の add 操作の動作を変更するために使用する。デフォルトのビヘイ

ビアでは、新しいグループが作成される。-n use または -n must_exist を指定すると、グループタイトル

と所有者ユーザー名の両方が一致した場合には、既存のリポジトリグループを使用する。このオプション

は、エクスポートしたリポジトリと同じリポジトリにデータをインポートする際、特に ACL リストを変更したく

ない場合に、 適である。

-o ハンドルマッピングレポートを取得する。

-q Quiet。コマンドを Quiet モードで実行する。すべての情報メッセージと、ユーザーによる「はい」または

「いいえ」の入力を促すプロンプトの表示を抑制する。すべてのプロンプトに対して、「はい」が入力され

たものとみなす。その際の実行結果についてはユーザーの責任となる。

-r リポジトリ参照。add 操作中に既存のリポジトリオブジェクトへの外部参照を可能とする。通常は、add

操作ではインポートファイル内のすべてのオブジェクト参照が、ファイル内で局所的に宣言されたオブジェ

クトへの参照でなければならない。グループとユーザーについてのみ例外がある(-n オプションを参照す

る)。Quiet モード(-q)が指定されていない場合は、外部参照が行われるたびにメッセージが表示され

る。

-t スレッド。 大スレッド数を指定する。デフォルトでは、マルチスレッドのインポート機能は無効となってい

る。2 から 20 の間の整数を設定すると、マルチスレッドのインポート機能が有効となる。

注: 大スレッド数は 20 である。20 以上の数値を指定した場合は、20 が適用される。スレッド性能は、ハードウェアに依存する。・・

概算としては、12500 個のドキュメントのインポートには約 58 分かかる。15 スレッドを指定すると、イン

ポート時間は約 53 分となる。つまり、2~20 個のスレッドに対し、およそ 5%~15%の時間短縮が得ら

れることになる。

-u ユーザー。コマンドを指定されたユーザーとして実行する。引数としてユーザーハンドルが必要である。デ

フォルトでは、すべてのコマンドを adim ユーザーの権限で実行する。これにより、コマンドにはすべての権

限が与えられ、また、コマンドが実行するすべての編集操作の実行者は、admin となる。例えば、-u

User-12 と指定すると、コマンドは admin ではなく、User-12 の権限で実行される。

-w Walker。リポジトリを変更することなく、操作を実行した場合の内容を示す。dsimport -w を指定する

と、要求されたすべての操作をシミュレーションし、それによって生じる変更と、発生するエラーまたは警

告を表示する。しかし実際にオブジェクトを変更することはない。

2–24 DocuShare Command Line Utilities Guide

Page 37: DocuShare コマンドラインユーティリティガイド

DocuShare Commands dsimport

dsimport の操作

add XML ファイルで指定された各オブジェクトを、DocuShare に新規オブジェクトとして追加する。入力ファ

イル内で定義された各オブジェクトに対し、新規オブジェクトがリポジトリに作成される。各オブジェクトに

は、オブジェクト作成における標準の規則に従った新しいハンドルが与えられます。入力ファイル内にお

ける元のハンドルへの参照はすべて、インポート処理中に新しいハンドルを使用するように変換される。

入力ファイルの dsobject 定義で定義されていないオブジェクトへのハンドル参照が存在した場合には、

エラーとなる。 modify modify および replace では、リポジトリハンドルの使用が可能である。これは、オブジェクト定義ファイル

は自己完結型でなければならないという条件の唯一の例外となる。この場合、既存のリポジトリオブジ

ェクトを参照できるのは 1 つのハンドル属性のみに限られている。オブジェクト定義ファイル内のそれ以

外の部分では、ファイルの外部を参照することはできない。 replace DocuShare データベースの既存のオブジェクトを置き換える。入力ファイルで指定された各オブジェクト

に対し、同一のハンドルを持つ既存のリポジトリオブジェクトが新しく入力された定義で置き換えられる。

ハンドルが存在しないオブジェクトを置換しようとすると、エラーメッセージが表示される。replace では、

明示的な値が指定されなかったプロパティに対し、現在のリポジトリ値のままではなくデフォルト値が設

定される。この点で、modify とは異なる。

大量オブジェクトのインポート

dsimport の先のコレクションが通知(即時、1 日に 1 回、1 週間に 1 回)を含む場合、大量の新しいオブジェクトがそのコレクションにインポー

トされると、DocuShare 通知サービスは不要な通知メールを発生させることがある。この問題を避けるために、2 つの方法のうちの 1 つを使用

することを推奨する。

1. 大量オブジェクトをインポートする前に、インポート先のコレクションから全ての通知を削除する。

2. 大量オブジェクトをインポートする前に、通知のないコレクションを作成して、そのコレクションにオブジェクトをインポートする。インポート

が終了したら、 終的にインポートしたいコレクションに、そのコレクションを移動する。 終的にインポートしたいコレクションに、通知

がどのように設定されるかにより、通知サービスは幾つかの通知メールを送信する。

DocuShare Command Line Utilities Guide 2–25

※注:DS6.6では通知サービスの停止(dsservice stop Notification)ができません。

Page 38: DocuShare コマンドラインユーティリティガイド

dsimport DocuShare Commands

dsimport の使用例

dsimport -d Collection-10 add /tmp/Collection-47/Collection-47.xml - ファイルを Collection-10 にインポートするには、次のよう

に入力する。

注:ファイルが、自動的にリフレッシュされることはないため、直ちに Web UI に表示されることはない。コレクションのページメニューで

「Refresh-再読み込み」を選択してください。

dsimport -n must_exist add /tmp/Collection-47/Collection-47.xml - 上記と同じファイルをインポートし、そのファイル内のユーザー

がサーバー上の既存ユーザーと完全に一致しない場合はエラーとなるようにするには、次のように入力する。

dsimport add User.xml - DocuShare の外部で定義された新規ユーザーアカウントセットをインポートするには、次のように入力する。

dsimport -n use -d Collection-12 -t 16 add Collection-10\Collection-10.xml - 16 スレッドを使用してデータをインポートする。

dsimport -n use -d Collection-12 -t 0 add Collection-10\Collection-10.xml - スレッドを使用せずにデータをインポートする。

dsimport –d collection-A add Collection-B\Collection-B.xml - Collection B のすべてのオブジェクトを Collection A にインポート

する。

dsimport –d collection-A add Space-B\Space-B.xml - Space B オブジェクトを除くすべてのオブジェクトをインポートする。

dsimport add Space-B\Space-B.xml - Space B オブジェクトを除くすべてのオブジェクトを、孤立オブジェクトとしてインポートする。

CSV/XML ファイルインポートの例

dsimport -d Collection-10 add Document\Document.csv - CSV ファイルをインポートする。

すべてのオブジェクトに適用される一般的な規則。

a. DocuShare ホストのフィールドは、必須である。

b. どのフィールドも、カンマが存在する場合は、ダブルクォートで囲む。

c. ハンドルフィールドは、常に必須である。異なるオブジェクト間の関係を指定するために使用する。

d. 一部のバッチ処理において、dsimport でオブジェクト間の関係を指定したくない場合には、定数値を入力することができる。ドキ

ュメントに対しては、すべてのドキュメントに Document-11 を、すべてのユーザーに User-11 を指定することができる。

e. DocuShare Document に対し、 小限必要となるフィールドと、その例を示す。

Document ハンドル、タイトル、レンディションファイル

Document-11, MyTitle, “Hello, World.doc”

f. DocuShare Collection に対し、 小限必要となるフィールドと、その例を示す。

Collection ハンドル、タイトル

Collection-11, “MyCollection-Hello, World”

g. DocuShare User に対し、 小限必要となるフィールドと、その例を示す。

User ハンドル、タイトル、ユーザー名、パスワード、ユーザーの姓(苗字)

User-11, userTitle, myname, mypassword, userLastName

注:スキーマにおいて、デフォルト値が設定されていない必須のカスタムプロパティが存在する場合は、そのプロパティをインポートファイルに含める必要がある。

2–26 DocuShare Command Line Utilities Guide

Page 39: DocuShare コマンドラインユーティリティガイド

DocuShare Commands dsimport

dsimport の動作について

dsimport コマンドは、入力データを解析し、それを有効なリポジトリオブジェクトに変換する必要がある。以下に示すように、データ、操作、オプ

ションの組み合わせにより、様々な動作上の条件を指定することができる。

必須プロパティを持つオブジェクトの追加、変更、および置換

add および replace 操作を実行する場合、すべてのインポートオブジェクトの全必須プロパティが空でなく、値が設定されていなければならない。

ほとんどのオブジェクトにおいて、必須プロパティは displayname である。必須以外のプロパティが設定されていなかった場合は、そのプロパティ

のデフォルト値が設定される。

dsimport の modify および replace は、メンバーシップと包含関係の変更および置換をサポートする。

以下に、例を示す。

1. Group-11 を dsexport する。

2. Group-11.xml を編集して、Group-11 のメンバーリストに User-14 を追加する。

3. dsimport modify Group-11\Group-11.xml を実行する。これにより、User-14 が Group-11 のメンバーとして追加される。

ユーザー

ユーザー定義の処理方法は、他のオブジェクトタイプとは異なる。ユーザー定義は、ハンドルではなく、ユーザー名によって、現在のリポジトリに

一致するものが存在するかどうかが検索される。-n オプションを指定した add 操作では、インポートするユーザーのユーザー名が既存のリポジト

リオブジェクトのユーザー名と一致した場合、そのユーザーはプレースホルダー参照としてのみ使用される。これにより、インポートファイル内の他

のオブジェクト定義において、そのユーザーオブジェクトを参照できるようになる。リポジトリのユーザーオブジェクトは変更されない。modify および

replace 操作では、ユーザー名プロパティのみで各ユーザーを一意に識別することが可能であり、対応するハンドルは必要ない。入力ファイルの

別の箇所で参照する場合に限り、ハンドルが必要となる。

DocuShare Command Line Utilities Guide 2–27

Page 40: DocuShare コマンドラインユーティリティガイド

dsimport DocuShare Commands

パスワード

XML ベースの DocuShare オブジェクト定義形式は、暗号化パスワードとプレーンテキストパスワードの両方をサポートする。

<!ELEMENT password ANY >・・

<!ATTLIST password

encoding (text, md5) #IMPLIED >

ユーザーをエクスポートする場合は、すべてのパスワードエントリが MD5 暗号化方式で暗号化される。暗号化した後に、他の DocuShare サ

ーバーへのインポートなどを実行する。DocuShare の外部で定義された新しいユーザー集合をインポートする場合は、必ずテキスト暗号化を

適用し、また、パスワードの値はクリアテキストのパスワードでなければならない。暗号化方式が指定されていない場合は、md5 が適用されて

いるものとみなされる。

2–28 DocuShare Command Line Utilities Guide

Page 41: DocuShare コマンドラインユーティリティガイド

DocuShare Commands dsindex

dsindex

構文:dsindex [オプション] -c チャンクサイズ <操作>

dsindex コマンドにより管理者は、DocuShare 検索データベースの圧縮、クリーンアップ、再インデックス、 適化を行うことができる。

注意: dsindex の実行中は、処理中の検索の精度が低下する可能性がある。

dsindex のオプション

-c チャンクサイズ。dsindex index_all のみに適用される。1 回のバッチ処理におけるファイル数を指定する。

-classname 指定されたクラス名のすべてのオブジェクトを、オブジェクトクラス名で再インデックスする。index 操作で

使用する。

例: dsindex -classname Document index

-collection 指定された Collection ハンドルに属するすべてのドキュメントオブジェクトに対し、インデックス作成する

(index のみ に適用される)。

-count <number> インデックス作成する、同一クラス内のオブジェクト数。ゼロ(0)を指定すると、クラス内のすべてのオブジ

ェクトに対しインデックス作成する。

-continue 実行中の dsindex コマンドが中断した後に、中断した場所からコマンドを再開する。

例: dsindex -continue index_all

-f フォアグラウンド。dsindex をフォアグラウンドで実行する。

-h ヘルプ。コマンドのヘルプを表示する。

-handles 指定されたハンドルのリストを再インデックスする。各ハンドルはカンマで区切り、ダブルクォートで囲んで

指定する。index 操作で使用する。

例: dsindex -handles "Document-11, Document-22,

Collection-15" index

-l レベル。ログファイルに指定レベル(debug、trace、info、warn、error、fatal)のメッセージを書き込む

-optType <number> Optimize コマンドに適用する 適化タイプを指定する。

-q Quiet。コマンドを Quiet モードで実行する。すべての情報メッセージと、ユーザーによる「はい」または

「いいえ」の入力を促すプロンプトの表示を抑制する。すべてのプロンプトに対して、「はい」が入力され

たものとみなされる。その実行結果についてはユーザーの責任となる。

-start <number> 同一クラスのオブジェクトに対する、インデックス番号の開始値を指定する。

-startingHandle <handle> index_all 操作を再開する際に開始するハンドルを指定する。

DocuShare Command Line Utilities Guide 2–29

<collection handle>

Page 42: DocuShare コマンドラインユーティリティガイド

dsindex DocuShare Commands

dsindex の操作

-fsizemax <number> Document オブジェクトの 大ファイルサイズをバイトで指定する。(指定した値を含む)

-fsizemin <number> Document オブジェクトの 小ファイルサイズをバイトで指定する。(指定した値を含まない)

例:dsindex -fsizemin 1000000 -fsizemax 5000000 index_all

この例はすべての DocuShare オブジェクトをインデックスするが、ファイルサイズが 1000000 バイト以上

か 5000000 バイト未満の Document オブジェクトは、コンテンツインデックスを持つ。残りのオブジェクト

は、メタデータインデックスだけを持つ。

index 指定されたクラス名を、オブジェクトクラス名または指定されたハンドルのリストでインデックス化する。-

classname または-handles オプションとともに使用する。 index_all データベース内のすべてのオブジェクトを、1 クラスずつカウントした後、それらを一括でインデックス化す

る。

max_clean 包括的な処理を行なう。古いファイルを削除し、データベースを圧縮し、ディスクをデフラグメント化し、

適化を実施する。サーバーを admin モードにする。 optimize パーティションをマージし、Autonomy データベースを 適化する。

2–30 DocuShare Command Line Utilities Guide

Page 43: DocuShare コマンドラインユーティリティガイド

DocuShare Commands dsinfo

dsinfo

構文:dsinfo [オプション]

dsinfo コマンドは、lib ディレクトリ配下の jar ファイルの情報を取得するために使用する。

dsinfo のオプション

-h ヘルプ。コマンドのヘルプを表示する。

-v Verbose。jar ファイルの詳細なステータスを表示する。

dsinfo の使用例

bin\dsinfo -v ..\lib\*.jar - すべての jar ファイルのステータスを取得するには、次のように入力する。

bin\dsinfo -v ..\lib\dscommon.jar - 1 つの jar ファイルのステータスを取得する

DocuShare Command Line Utilities Guide 2–31

Page 44: DocuShare コマンドラインユーティリティガイド

dslock DocuShare Commands

dslock

構文:dslock [オプション] ハンドル

dslock コマンドにより管理者は、オブジェクトをロックすることができる。複数のオブジェクトハンドルを指定する場合は、スペースで区切る。

dslock

dslock コマンドは、引数として DocuShare ファイルハンドル(Document-23 など)のみを必要とする。dslock コマンドは、指定された

DocuShare ファイルオブジェクトをロックする。指定されたハンドルが DocuShare データベースに見つからなかった場合、あるいはハンドルが

DocuShare ファイルオブジェクトを参照するものではなかった場合は、コマンドはハンドルが見つからなかったことを示すメッセージを表示し、ステ

ータス-1 で終了する。既にロックされているファイルを指定しても、エラーとはならない。

dslock のオプション

-h ヘルプ。コマンドのヘルプを表示する。

-l レベル。ログファイルに指定レベル(debug、trace、info、warn、error、fatal)のメッセージを書き込む。

-q Quiet。コマンドを Quiet モードで実行する。すべての情報メッセージと、ユーザーによる「はい」または

「いいえ」の入力を促すプロンプトの表示を抑制する。すべてのプロンプトに対して、「はい」が入力され

たものとみなす。その実行結果についてはユーザーの責任となる。

-u ユーザー。コマンドを指定されたユーザーとして実行する。引数としてユーザーハンドルが必要である。デ

フォルトでは、すべてのコマンドを admin ユーザーの権限で実行する。これにより、コマンドにはすべての

権限が与えられ、また、コマンドが実行するすべての編集操作の実行者は、admin となる。例えば、-u

User-12 と指定すると、コマンドは admin ではなく、User-12 の権限で実行される。

2–32 DocuShare Command Line Utilities Guide

Page 45: DocuShare コマンドラインユーティリティガイド

DocuShare Commands dsorphan

dsorphan

構文:dsorphan [オプション] <list <top|all|クラス名>|reassign <ハンドル+|all|クラス名>>

dsorphan コマンドにより管理者は、孤立オブジェクトの一覧表示と再割り当てを行うことができる。

dsorphan のオプション

-d 割り当て先。孤立オブジェクトを再割り当てするコレクションハンドルを指定する。reassign 操作におい

て必要となる。

-h ヘルプ。コマンドの使用方法に関する情報を出力する。

-l ログ記録レベル。ログファイルに指定レベル(debug、trace、info、warn、error、fatal)のメッセージを書

き込む。

-q Quiet。コマンドを Quiet モードで実行する。すべての情報メッセージと、ユーザーによる「はい」または

「いいえ」の入力を促すプロンプトの表示を抑制する。すべてのプロンプトに対して、「はい」が入力され

たものとみなする。その実行結果についてはユーザーの責任となる。

-s サブコレクション。孤立オブジェクトを所有している各ユーザーのために、目的のフォルダの下にサブコレク

ションを作成する。サブコレクションのタイトルは、ユーザーハンドルから始まり、スペース、ユーザーログイ

ン名が続く。

dsorphan の操作

list 孤立オブジェクトを一覧表示する。オプションとして、top、all、またはクラス名を指定する。

a. top オプションは、すべての孤立オブジェクトを一覧表示する。

b. all オプションは、すべての孤立オブジェクトとその子オブジェクトを一覧表示する。

c. クラス名オプションは、そのクラスに属するすべての孤立オブジェクトを一覧表示する。

reassign 孤立オブジェクトを、-d オプションで指定されたコレクションに再割り当てる。適用対象は、キーワード

all、または、スペースで区切られた孤立オブジェクトハンドルまたはクラス名のリストによって指定する。

dsorphan の使用例

dsorphan list all - すべての孤立オブジェクトを一覧表示する。

dsorphan list Document - すべての Document 孤立オブジェクトを一覧表示する。

DocuShare Command Line Utilities Guide 2–33

Page 46: DocuShare コマンドラインユーティリティガイド

dsservice DocuShare Commands

dsservice

構文:dsservice [オプション] <操作> サービス

dsservice コマンドにより管理者は、DocuShare サービスのステータスに対する問合せまたは変更を行うことができる。

注:通常の稼働条件下では、dsservice を使用しない。dsservice は、問題の調査や解決、および特殊な要件をサポートするために用意さ

れている。DocuShare カスタマーサポートによる指示がある場合以外は使用しない。

dsservice のオプション

-h ヘルプ。コマンドのヘルプを表示する。

-q Quiet。コマンドを Quiet モードで実行する。すべての情報メッセージと、ユーザーによる「はい」または

「いいえ」の入力を促すプロンプトの表示を抑制する。すべてのプロンプトに対して、「はい」が入力され

たものとみなす。その実行結果についてはユーザーの責任となる。

dsservice の操作

checkpoint <テキスト> この<テキスト>を含んでいるログ中にチェックポイントを配置する。

continue サブシステムの手動による起動を可能とするために、モニターを一時停止状態から再開する。

注意:DocuShare サポートによる指示がある場合以外は、使用しない。

dsstatus DocuShare サーバーサブコンポーネントの状態を表示する。

host <値> localhost のデフォルト以外の場合 RMI ホスト。

kill システムを強制終了する。モニター側からの応答がないため、この制御プログラムがリモート例外をキャ

ッチする。

port <value> デフォルト 1099 以外の場合 RMI ポート。 report 各監視対象サービスの現在のステータスを一覧表示する。

recycle <値> 「障害発生時の再起動」に対し、true または false の値を設定する。

restart システムを再起動する。

shutdown システムを停止する。

state <新しい状態> システム状態を、admin、readonly、normal のいずれかに変更する。

start <サービス> 指定されたサービスを起動する。

status DocuShare システムおよびサービスのステータスを表示する。

stop <サービス> 指定されたサービスを停止する。明示的に起動を要求しない限り、モニターサービスによって再起動さ

れることはない。

usage ヘルプを表示する。

verbose モニターは、verbose モードで稼働する。

2–34 DocuShare Command Line Utilities Guide

Page 47: DocuShare コマンドラインユーティリティガイド

DocuShare Commands dsservice

dsservice のサービス引数

dsservice の構文における <サービス>引数には、DocuShare サービスの名前を指定する。この引数では、大文字と小文字が区別

される。dsservice status を実行すると、引数の一覧が表示される。

注:引数の一覧にリストされるいくつかのサービスは、サービスに組み込まれている。それらのサービスは他の JVM 内で実行し、

dsservice コマンドを使用して再起動できない。

DocuShare Command Line Utilities Guide 2–35

Page 48: DocuShare コマンドラインユーティリティガイド

dssetup DocuShare Commands

dssetup

構文: dssetup

dssetup コマンドは、現在の DocuShare 構成を変更するための DocuShare のインタラクティブな構成設定ツールを起動する。

dssetup の引数

help コマンドのヘルプを表示する。

config <ファイル> DocuShare のコンフィギュレーションプロパティの場所。

testport <ポート> <ポート>がフリーかテストする。

status Tomcat のステータスをテストする。

システム構成設定

DocuShare のシステム構成設定を参照もしくは変更する。

1. stop_docushare を実行する。

2. システム構成リストを表示するために dssetup を実行する。

注:表示されるシステム構成はインストールされた DocuShare のバージョンあるいはサイトがどうインストール・構成されたかに依存する。

3. システム構成に変更を加える。

4. start_docushare を実行する。

表 2-3:変更可能なシステムプロパティと値

構成名 デフォルト設定

現在のバージョン サイトの DocuShare ビルドバージョン

現在のアップデート インストールされている全てのソフトウェアアップデートとパッチ

ホスト DNS 名 サーバーの完全修飾 DNS 名

RMI ポート番号 1099

RMI ホスト サーバー名

Tomcat http ポート<ステータス オン/オフ> 8080 / オン

Tomcat ブリッジポート <ステータス オン/オフ> 8009 / オン

Tomcat サーバーポート番号 8005

Tomcat JVM ルート tomcat1

Tomcat DocuShare ルート docushare

通知(Subscription)ポート番号 8080

2–36 DocuShare Command Line Utilities Guide

Page 49: DocuShare コマンドラインユーティリティガイド

DocuShare Commands dssetup

表 2-3:変更可能なシステムプロパティと値

構成名 デフォルト設定

HTTP プロトコル http

データベースホスト 現在のデータベースホスト名

データベースポート番号 1433

データベースリンクチャンクサイズ 100

データベース検索結果チャンクサイズ 100

データベースユーザー sa

データベース名 Docushare

データベースは命名されたインスタンスである true

データベースインスタンス名 docushare

DocuShare SMTP サーバー ゲートウェイの完全修飾 DNS 名

DocuShare SMTP サーバーポート 25

DocuShare admin の電子メールアドレス 管理者の電子メールアドレス

DocuShare 2.2 cookie のサポート false

IDOL Dish Server ポート 20000

IDOL Dish Server svc ポート 20002

IDOL Server aci ポート 9000

IDOL Server ndx ポート 9001

IDOL Server svc ポート 9002

IDOL FSF Server ポート 7000

IDOL FSF Server svc ポート 10023

IDOL Dish Server ホスト名 127.0.0.1

IDOL Server ホスト名 127.0.0.1

IDOL FSF Server ホスト名 127.0.0.1

IDOL Search Server ホスト名 127.0.0.1

IDOL Server installdir C:\Xerox\ds63b53\IDOLServer

Interact 有効化 false

SMB scan 有効化 false

通知 有効化 true

システム RMI リトライカウント 20

システムリスタートカウント 2

DocuShare Command Line Utilities Guide 2–37

Page 50: DocuShare コマンドラインユーティリティガイド

dssetup DocuShare Commands

表 2-3:変更可能なシステムプロパティと値

構成名 デフォルト設定

ホスト ID サイトのホスト ID

ホストシステムプラットホーム サイトのシステムプラットホーム(Windows 2003 など)

失敗時のリスタート true

ロギングレベル INFO

モニタータイプ Primary

追加ルート 有効化 false

2–38 DocuShare Command Line Utilities Guide

Page 51: DocuShare コマンドラインユーティリティガイド

DocuShare Commands dsstats

dsstats

構文:dsstats [オプション] [all] [クラス名+]

dsstats コマンドは、DocuShare サーバー統計と関連情報を作成する。作成されたデータは、メンテナンスやトラブルシューティングに使用する

ことができる。 大規模な DocuShare サイトでは、「DocuShare について」ページにある Web UI の統計オプションの代わりに、dsstats コマンドを

使用する必要がある。

dsstats のオプション

all すべてのクラスに対し、オブジェクト総数を表示する。

キーワード all は、dsstats に続く、 初の引数として指定しなければならない。

-h dsstats の使用方法に関する情報を表示する。

-l ログファイルに指定レベル(debug、trace、info、warn、error、fatal)のメッセージを書き込む。

-q Quiet。コマンドを Quiet モードで実行する。すべての情報メッセージと、ユーザーによる「はい」または

「いいえ」の入力を促すプロンプトの表示を抑制する。すべてのプロンプトに対して、「はい」が入力され

たものとみなす。その実行結果についてはユーザーの責任となる。

dsstats の使用例

dsstats all – 現在サイトにある全オブジェクトの数を表示する。

dsstats Document Version Rendition URL - 現在サイトにある特定オブジェクトの数を表示する。

DocuShare Command Line Utilities Guide 2–39

Page 52: DocuShare コマンドラインユーティリティガイド

dstrashcan DocuShare Commands

dstrashcan 構文:dstrashcan [オプション] <list:expunge:restore> <ハンドル+:all:expired:top>

dstrashcan コマンドにより管理者は、DocuShare ごみ箱内のオブジェクトを、一覧表示、復元、または削除することができる。

dstrashcan のオプション

-f csv ファイル名。ごみ箱情報を、コンソールから取得可能な CSV ファイルにエクスポートする。

-h ヘルプ。コマンドのヘルプを表示する。

-l レベル。ログファイルに指定レベル(debug、trace、info、warn、error、fatal)のメッセージを書き込む。

-q Quiet。コマンドを Quiet モードで実行する。すべての情報メッセージと、ユーザーによる「はい」または「い

いえ」の入力を促すプロンプトの表示を抑制する。すべてのプロンプトに対して、「はい」が入力されたも

のとみなす。その実行結果についてはユーザーの責任となる。

dstrashcan の操作

expunge ごみ箱のコンテンツを削除する。適用対象は、スペースで区切って指定されたオブジェクトハンドル、す

べてのオブジェクト、または有効期限切れのオブジェクトとなる。

list ごみ箱のコンテンツを一覧表示する。表示範囲としては、all(トップレベルのオブジェクトハンドルとそのコ

ンテンツ)、expired(トップレベルの有効期限切れのハンドルとそのコンテンツ)、または top(トップレベル

のオブジェクト)のいずれかを指定する。 restore ごみ箱のコンテンツを復元する。適用対象は、スペースで区切って指定されたオブジェクトハンドル、す

べてのオブジェクト、または有効期限切れのオブジェクトとなる。復元先は、そのオブジェクトの元の親と

なる。

dstrashcan の使用例

dstrashcan -f csv list top – ごみ箱のコンテンツを CSV ファイルとして表示する。

2–40 DocuShare Command Line Utilities Guide

Page 53: DocuShare コマンドラインユーティリティガイド

DocuShare Commands dsunlock

dsunlock

構文:dsunlock [オプション] ハンドル

dsunlock コマンドにより管理者は、オブジェクトをアンロックすることができる。複数のオブジェクトハンドルを指定する場合は、スペースで区切る。

dsunlock

dsunlock コマンドは、引数として DocuShare ファイルハンドル(Document-23 など)のみを必要とする。

dsunlock コマンドは、指定された DocuShare ファイルオブジェクトをアンロックする。指定されたハンドルが DocuShare データベースに見つから

なかった場合、あるいはハンドルが DocuShare ファイルオブジェクトを参照するものではなかった場合は、コマンドはハンドルが見つからなかった

ことを示すメッセージを表示し、ステータス-1 で終了する。ロックされていないファイルをアンロックしても、エラーとはならない。

dsunlock のオプション

-h ヘルプ。コマンドのヘルプを表示する。

-l レベル。ログファイルに指定レベル(debug、trace、info、warn、error、fatal)のメッセージを書き込む。

-q Quiet。コマンドを Quiet モードで実行する。すべての情報メッセージと、ユーザーによる「はい」または

「いいえ」の入力を促すプロンプトの表示を抑制する。すべてのプロンプトに対して、「はい」が入力され

たものとみなす。その実行結果についてはユーザーの責任となる。

-u User.コマンドを指定されたユーザーとして実行する。引数としてユーザーハンドルが必要である。デフォ

ルトでは、すべてのコマンドを admin ユーザーとして実行する。これにより、コマンドにはすべての権限が

与えられ、また、コマンドが実行するすべての編集操作の実行者は、admin となる。例えば、-u

User-12 と指定すると、コマンドは admin ではなく、User-12 として実行される。

DocuShare Command Line Utilities Guide 2–41

Page 54: DocuShare コマンドラインユーティリティガイド

dsupload DocuShare Commands

dsupload 構文:dsupload [オプション]

dsupload コマンドにより管理者は、複数のドキュメントを複数のコレクションにアップロードすることができる。

注:DocuShare サイトの関連リンクから表示されるウェブサイトおよびオンラインサポートリソースでは、様々な情報やサポートを得ることができる。

dsupload のオプション

-a 任意の初期パーミッション設定(inherit:ownerwrite:owner)。デフォルト設定は inherit(継承)。

-c 指定された Collection へとアップロードする。コレクションを指定しない場合は、ドキュメントは孤立オブ

ジェクトとしてアップロードされる。

複数のコレクションオブジェクトハンドルを、カンマで区切って指定することができる。

-d オプションの DocuShare ドメイン名。

-D ドメイン名またはスタンドアロンサーバー名。SMB 共有をウォッチする場合のみに適用される。

-h ヘルプ。コマンドの使用方法に関する情報を出力する。

-i 入力ウォッチフォルダ。Win32 UNC パスまたはローカルディスクのパスをカンマで区切って指定する。

-j アップロードアクションを拡張するか無効にするかの任意の Java コールバック。

-l レベル。ログファイルに指定レベル(debug、trace、info、warn、error、fatal)のメッセージを書き込む。

-m 任意のメタデータ(属性)ファイルの場所

-o オプションの出力アーカイブフォルダ。Win32 UNC パスまたはローカルディスクのパスをカンマで区切って

指定する。

-P ドメインまたはスタンドアロンサーバーユーザー名。SMB 共有をウォッチする場合のみに適用される。

-q Quiet。コマンドを Quiet モードで実行する。すべての情報メッセージと、ユーザーによる「はい」または

「いいえ」の入力を促すプロンプトの表示を抑制する。すべてのプロンプトに対して、「はい」が入力され

たものとみなする。その実行結果についてはユーザーの責任となる。

-t ポーリング間隔(単位:分)を指定する。

-u オプションの DocuShare ドメインユーザー名。

-U ドメイン名またはスタンドアロンサーバー名。SMB 共有をウォッチする場合のみに適用される。

2–42 DocuShare Command Line Utilities Guide

Page 55: DocuShare コマンドラインユーティリティガイド

DocuShare Commands dsupload

dsupload の使用例

dsupload -i D:\testsmb\watched1 -c Collection-12 -ローカルディスクパスをウォッチし、Collection-12 にアップロードする。

dsupload -i D:\testsmb\watched1 -c Collection-12 -d DocuShare -u <VALUE> - ユーザー名を指定することにより、別のユー

ザーとしてアップロードを実行する。

dsupload -i D:\testsmb\watched1 -c Collection-12 -t 5 - 例 1 を、より長いウェイト間隔で実行する(値は分で指定する)。

dsupload -i \\dsdev18\shareA -c Collection-12 -D <VALUE> -U <VALUE> -P <VALUE> - SMB 共有をウォッチする。SMB

認証が必要となる。

注:-d オプションは DocuShare ドメイン名、-D オプションは SMB ドメインまたはサーバー名に使用する。同様に、-u オプションは

DocuShare ドメインユーザー名、-U オプションはドメインまたはスタンドアロンサーバーユーザー名に使用する。

DocuShare Command Line Utilities Guide 2–43

Page 56: DocuShare コマンドラインユーティリティガイド

fixupMimeTypes DocuShare Commands

fixupMimeTypes

構文:fixupMimeTypes [オプション]

fixupMimeTypes コマンドは、不整合な MIME タイプを確認して、修復する。このコマンドは、index_all を実行する前ではなく、サイトをアップグ

レードした後に使用する。countFileNumber コマンドと併せて使用する。

fixupMimeTypes のオプション

-h コマンドのヘルプを表示する。

-f DocuShare MIME テーブルで定義されているファイルの拡張子と不整合な MIME タイプを持つドキュ

メントの MIME タイプを変更するためにデータベースをアップデートする。

-r 全てのドキュメントのレポートを stdout に送る。レポートは、ドキュメントハンドル、ファイル名、MIME タ

イプ、サイズを示す。ドキュメントの MIME タイプが DocuShare MIME テーブルで定義されているファイ

ルの拡張子と不整合だった場合、 レポートはドキュメントに "****"を付ける。

fixupMimeTypes の使用例

fixupMimeTypes -f — このコマンドを実行した結果として変更された全てのドキュメントクラスのリストを表示する。

fixupMimeTypes -r — 全てのドキュメントのレポートを stdout に送る。

2-44 DocuShare Command Line Utilities Guide

Page 57: DocuShare コマンドラインユーティリティガイド

DocuShare Commands getIndexReport

getIndexReport

構文:getIndexReport

getIndexReport コマンドは、リレーショナルデータベースに格納されたオブジェクトの数と検索データベースに格納されたオブジェクトの数を

比較する。

getIndexReport

DocuShare オブジェクトが作成されたか変更された際に、その後の検索が 新のデータをベースに見つけることができるように、検索データベー

スにはこの変更が通知される。時々、システム障害のために、新しいもしくは変更されたオブジェクトが検索データベースにインデックスされない

ことがある。これが起こっているかどうか見つけ出すために getIndexReport を使用し、次にその問題を修正するために reindexChangeSince

を使用する。

DocuShare Command Line Utilities Guide 2–45

Page 58: DocuShare コマンドラインユーティリティガイド

idoltool DocuShare Commands

idoltool 構文:idoltool {<IDOL インストールディレクトリ>}

idoltool コマンドを使用して、IDOL 検索エンジンとインデックスサーバーを構成、管理する。

注意:このコマンドを使用する前に、DocuShare カスタマーサポートに連絡してください。

idoltool の使用

idoltool は、その他ほとんどの DocuShare コマンドラインとは異なる動作をする。

1. 他のコマンドと同様に、DocuShare/bin ディレクトリに移動するためにコマンドプロンプト・ウィンドウを使用する。

2. プロンプトでは、idoltool(オプションの IDOL ディレクトリ)をタイプし、実行する。システムは idoltool を開始する。

idoltool が準備できている場合、プロンプトが表示される。

3. プロンプトでは、コマンドおよび<パラメーター>を入力し、実行する。

基本の idol ディレクトリ<dir>は、DiSH、FileSystem Fetch、IDOL を含んでいる。

システムはコマンドを実行し、コマンドおよび選択されたパラメーターの結果に基づいた情報を返す。

idoltool のコマンド

getstatus <server, all> 指定されたサーバーの現在のステータスを表示する。

このコマンドを動作させるためには、サーバーが稼動している必要がある。

info 全てのサーバーのシステム構成を表示する。 addinstance 既存の IDOL サーバーのインスタンスがその限界(1000 万から 1200 万と推測される。)に達

した場合に、システムに IDOL サーバー(content.exe)インスタンスを追加する。

インスタンスを追加するには;DocuShare を停止;サーバを停止;idoltool を実行;

addinstance を実行;サーバを再起動;DocuShare を再起動

backup <directory> {<server>} インデックスデータをバックアップする。指定した<directory>内のインデックスデータの圧縮コピ

ーを作成する。backup コマンドは、export コマンドよりずっと速い。

このコマンドは、idoltool restore オプションと併せて使用する。

<server>の指定は、オプションである。単一の content.exe インスタンスの場合のデフォルト

は、idol である。複数の content.exe インスタンスの場合は、サーバーの引数に content0,

content1 などを使用して、それぞれに異なったディレクトリーの場所を指定する。

構文:idoltool -s backup <directory> {<server>}

-s は、単数コマンドモードを表す。

例:idoltool -s backup c:\backup

2–46 DocuShare Command Line Utilities Guide

Page 59: DocuShare コマンドラインユーティリティガイド

DocuShare Commands idoltool

restore <directory> {<server>} インデックスデータを復元する。指定した<directory>内のインデックスデータを圧縮したバック

アップコピーを展開する。

このコマンドは、idoltool backup オプションと併せて使用する。

<server>の指定は、オプションである。単一の content.exe インスタンスの場合のデフォルト

は、idol である。複数の content.exe インスタンスの場合は、サーバーの引数に content0,

content1 などを使用して、それぞれに異なったディレクトリーの場所を指定する。

構文:idoltool -s restore <directory> {<server>}

-s は、単数コマンドモードを表す。

例:idoltool -s restore c:\backup

initdb インデックスデータベースのコンテンツをリセットする。このコマンドを動作させるためには、サーバ

ーが稼動している必要がある。

export <dir> 指定されたディレクトリ内の圧縮ファイルへインデックスデータベースのコンテンツをエクスポート

する。このコマンドを動作させるためには、サーバーが稼動している必要がある。<dir>パスはス

ペースを含まないこと。

再インデックスが必要な IDOL の構成変更がある場合、Export/Import を backup/restore

の代わりに使用する。

import <dir> 指定されたディレクトリから圧縮ファイルをインポートする。このコマンドを動作させるためには、

サーバーが稼動している必要がある。

再インデックスが必要な IDOL の構成変更がある場合、Export/Import を backup/restore

の代わりに使用する。

resizeindexcache <sizeInKB> 指定されたサイズにインデックス・キャッシュ・メモリーをセットする。このコマンドを動作させるた

めには、サーバーが稼動している必要がある。サーバーの再起動は必要としない。

setcontentdir <server> <root dir> 指定されたルートディレクトリにコンテントコンポーネントディレクトリをセットする。Idol と

ContentX サーバーにのみ有効。このコマンドを動作させるためには、サーバーが停止してい

る必要がある。

resetserver <server, all> 指定されたサーバーからファイルを削除する。このコマンドを動作させるためには、サーバーが

停止している必要がある。

resetlicense Dish サーバーと、Idol とコンテンツサーバーのライセンスデータをリセットする。このコマンドを動

作させるためには、サーバーが停止している必要がある。

DocuShare Command Line Utilities Guide 2–47

Page 60: DocuShare コマンドラインユーティリティガイド

idoltool DocuShare Commands

setconfig <server> <parameter IDOL 構成ファイル(.cfg)の引数の値をセットする。

key> <value> <server>は、idol、filesystemfetch、dish などのサーバー名である。

<parameter key>は、Server.NodeTableMaxFieldLength などの<section>.<parameter>

である。この例では、そのパラメーターは構成ファイルの[Server]セクションの下に配置されて

いる。

<value>は、引数の値である。

NodeTableMaxFieldLength 引数の使用

IDOL インデックスデータベースのどのフィールドにも格納できるドキュメントコンテンツの 大サ

イズをセットする。

IDOL は、すべてのインデックスされたドキュメントコンテンツのコピーを保持する。ディスクスペー

スの使用量を減らすには、このコマンドで IDOL がディスクに保存するバイト数の上限をセット

する。デフォルト値は、400000 バイトである。

値の変更を推奨する場合は、DocuShare サポートに連絡してください。文書に基づいたア

ジア言語のための値は、より高いかもしれない。値を 0 に設定すると、ドキュメントコンテンツ

サイズは無制限になる。値は、IndexServerConfig.xml に書かれる。

変更を有効にするには、DocuShare を再起動する。

注意:コマンドでセットした値に達すると、IDOL はドキュメントの残りのテキストのインデックス

を停止する。

例:idoltool コマンドである setconfig idol Server.NodeTableMaxFieldLength 600000 を

実行すると、IDOL インデックスデータベースのどのフィールドにも格納できるドキュメントコンテ

ンツの 大サイズが 600KB にセットされる。

setinstalldir 全てのサーバーの初期化されていない cfg ファイルに、現在の IDOLInstallDir をセットする。

このコマンドを動作させるためには、サーバーが停止している必要がある。

stop <server, all> 指定されたサーバーを停止する。このコマンドを動作させるためには、サーバーが稼動してい

る必要がある。

export/import を使用して IDOL インデックスデータベースをバックアップ、復元する

存在している IDOL インデックスデータベースをバックアップする。

1. バックアップを始める前に、対象のディレクトリーが存在していて、空であることを確認する。

2. Windows の場合は、idoltool.bat -s export <exportdir>を実行する。

Solaris/Linux の場合は、idoltool.sh -s export <exportdir>を実行する。

3. バックアップを実行した時間と日付を記録する。

バックアップした IDOL インデックスデータベースを復元する。

1. Windows の場合は、idoltool.bat -s import <exportdir>を実行する。

Solaris/Linux の場合は、idoltool.sh -s import <exportdir>を実行する。

2. 記録したバックアップの時間と日付を調べる。 後の export 操作から変更があるとき、Windows の場合は、

reindexChangesSince.bat "MM/dd/yyyy hh:mm:ss"を実行する。Solaris/Linux の場合は、reindexChangesSince.sh

"MM/dd/yyyy hh:mm:ss"を実行する。

"MM/dd/yyyy hh:mm:ss"は、 後に export 操作をした日時である。このコマンドの例は、reindexChangesSince.bat

"05/15/2009 13:15:00"となる。

2–48 DocuShare Command Line Utilities Guide

Page 61: DocuShare コマンドラインユーティリティガイド

DocuShare Commands idolsetup

idolsetup 構文: idolsetup.bat ..\config\<オプション> (Windows の場合)

idolsetup.sh ../config/<オプション> (UNIX の場合)

idolsetup コマンドは、IDOL サービスが動作している 64 ビットサーバーのメモリリソースにマッチする IDOL サービスを構成することによっ

てインデックスの動作を 適化するために使用する。

idolsetup のオプション

サーバーのメモリ容量を調べて、適切なオプションを使用し、idolsetup コマンドを実行する。

idol_default.config 4GB 以上、8GB 未満の容量の RAM の 64 ビットサーバーの場合。

idol_medium.config 8GB 以上、16GB 未満の容量の RAM の 64 ビットサーバーの場合。

idol_large.config 16GB 以上、32GB 未満の容量の RAM の 64 ビットサーバーの場合。

idol_unlimited.config 32GB 以上の容量の RAM の 64 ビットサーバーの場合。

idolsetup の使用例

idolsetup.bat ..\config\idol_medium.config – 8GB から 16GB の間の有効なメモリを持つ Windows サーバーのリソースにマッチ

するために IDOL サービスを構成することによって 適化する。

DocuShare Command Line Utilities Guide 2–49

Page 62: DocuShare コマンドラインユーティリティガイド

recoverIndex DocuShare Commands

recoverIndex 構文: recoverIndex <オプション> <ハンドル>

recoverIndex コマンドは、いかなる記録された検索データベースの障害、あるいは DocuShare が検索データベースと接続できない障

害を見つける。DocuShare はこれらのタイプの障害を多く記録するが、あまりにも多数が生じた場合にはシャットダウンする。正しい操

作と組み合わせた recoverIndex コマンドは、これらの障害が記録されたか判断することができる。検索データバース問題が解決され

れば、recoverIndex コマンドは失敗したオペレーションを再び試みることができる。

recoverIndex のオプション

-clear リカバリーリストのコンテンツをクリアーする。

-h コマンドヘルプテキストを表示する。

-recover 検索データベース問題が解決されたあとにオペレーションをリトライする。

-recover –handle 指定されたオブジェクトを正常な状態に戻す。

-report DocuShare によって記録されたあらゆる検索データベースの障害を発見する。

recoverIndex の使用例

recoverIndex -clear – リカバリーリストの全てのコンテンツをクリアーする。

recoverIndex -report – インデックスできなかったオブジェクトハンドル、障害の発生時間、および問題を改善する方法につい

ての提案を提供する JAVA スタイルエラーレポート(スタックトレース)をリストするログを表示する。

recoverIndex -recover -handle Document-123 - ログから、この特定のオブジェクトのインデキシング障害のレコードをクリアーする。

recoverIndex -recover - ログをクリアーする。

2–50 DocuShare Command Line Utilities Guide

Page 63: DocuShare コマンドラインユーティリティガイド

DocuShare Commands reindexChangesSince

reindexChangesSince 構文: reindexChangesSince <日付>

reindexChangesSince コマンドは、付与された日付以降作成された、あるいは修正されたサイトコンテントを再インデックスする。

reindexChangesSince の操作

日付が唯一の操作である。日付は、引用符で囲まれた“mm/dd/yyyy hh:mm:ss”フォーマットであること。

時間は 24 時間で表される。

reindexChangesSince の使用例

reindexChangesSince “05/15/2009 13:15:00” – 05/15/2009 13:15:00 のオペレーション日時以降作成された、あるいは

修正されたサイトコンテントすべてを再インデックスする。

DocuShare Command Line Utilities Guide 2–51

Page 64: DocuShare コマンドラインユーティリティガイド

resetIndexes DocuShare Commands

resetIndexes 構文: resetIndexes [オプション] <ログファイルのフルパス名>

DocuShare データベースインデックスのデフォルトの設定を再構築するために使用する。resetIndexes コマンドは、全ての DocuShare

のデータベースインデックスをドロップし、再適用する。実行中、コマンドはドロップと追加ごとにログを表示して、指定したログファイルに結

果を書き込む。

resetIndexes のオプション

-h コマンドのヘルプを表示する。

-l 指定したログファイルにコマンドの出力を書き込む。デフォルトのログファイルは stdOut である。

2–52 DocuShare Command Line Utilities Guide

Page 65: DocuShare コマンドラインユーティリティガイド

DocuShare Commands setindexconfig

setindexconfig 構文: setindexconfig [options] <propertyname><value>

setindexconfig コマンドは、 IndexServerConfig.xml ファイルに指定されたプロパティの値をセットする。値の変更は、インデックスサーバーを停

止したり、再起動したりすることなく、すぐに有効になる。

IndexServerConfig.xml は、インデックスサーバーの構成ファイルである。このファイルは、インデックスサーバーの動作を管理する。

setindexconfig のオプション

-h コマンドのヘルプを表示する。

-q Quiet モードで実行する。

-l ログファイルに指定レベル(debug、trace、info、warn、error、fatal)のメッセージを書き込む。

例: l{debug}

-section {server|indexer} プロパティが置かれた IndexServerConfig.xml ファイルにセクションを指定する。指定

しない場合は、プロパティはサーバーセクションにセットされる。

indexServerConfig.xml のプロパティ名と値

プロパティ名は、大文字と小文字が区別される。

プロパティ名 デフォルト値 機能

Server セクション

chunkSize 500 インデックスジョブのチャンクごとの 大オブジェクト数

numberOfIndexingThreads 1 インデックスジョブを IDOL にサブミットするために使用される

スレッド数

numberOfDataThreads 1 DSServer からデータを取得するために使用されるスレッド

enableContentIndexing true true = ドキュメントテキストコンテンツのインデックスを有効に

する

false = テキストコンテンツのインデックスを無効にする

logLevel INFO ログ記録レベル

timeout 60 インデックスジョブが終了するまでの時間(分)

timing false true の場合、timing 情報をログに追加する

verbose false true の場合、 timing 情報のより大きい合計をログに追加

する

badIndexHandles none コンテンツインデックスにスキップされるドキュメントオブジェクト

のハンドルをコンマで分ける

generateSummary false ture の場合、ドキュメントオブジェクトの抜粋を作成して保

存する

maxIndexRetry 10 終了する前に、インデックスジョブを再試行する回数

DocuShare Command Line Utilities Guide 2-53

Page 66: DocuShare コマンドラインユーティリティガイド

setindexconfig DocuShare Commands

プロパティ名 デフォルト値 機能

indexingQThreshold 30 indexingQ が指定したパーセントの値より多いイベントを含

む場合、Index_all を中止する

eventWait 1000 indexingQ のイベントを待つインデックスサーバーの 大時

間(ms)

jobLatency 1000 インデックスジョブを作成したとき、イベントからハンドルを集

める 大時間(ms)

idolInitTimeout 10 IDOL サーバーの開始を待つ 大時間(分)

consecutiveFailedJobsLimit 10 インデックスサーバーがシステムのシャットダウンを示す前に連

続して失敗するインデックスジョブの数

contentIndexMaxFileSize 0 ファイルが指定した値を超えるとコンテンツインデックスを無効

にする

デフォルト値の 0 は、無制限を意味する

Indexer セクション

name IDOL 編集しないこと

classname com.xerox.docushare.index.serv

er.autonomy.IdolIndexer

編集しないこと

installdir d:\ds\cpx660b841\IDOLServer インストーラーがセットする; 編集しないこと

IDOLServerHost 127.0.0.1 編集しないこと

FSFServerHost 127.0.0.1 編集しないこと

aciPort 9000 インストーラーがセットする; 編集しないこと

ndxPort 9001 インストーラーがセットする; 編集しないこと

fsfPort 7000 インストーラーがセットする; 編集しないこと

tokenization morphological Tokenization メソッドは、インデキシングを使用する

他の値は、アジア言語ではオプションとなる "ngram"である

2–54 DocuShare Command Line Utilities Guide

Page 67: DocuShare コマンドラインユーティリティガイド

DocuShare Commands setStorageUpgradeConfig

setStorageUpgradeConfig 構文: setStorageUpgradeConfig [options]

setStorageUpgradeConfig コマンドは、DocuShare 6.6 で提供されたコンテンツストアをアップグレードする機能の有効化/無効化を設定し、

毎日の停止/開始時間を設定する。このコマンドは、非常に深く、バックアップアプリケーションが扱うには複雑すぎるディレクトリー階層に格納さ

れたバックアップデータに問題があり、DocuShare 6.6 にアップグレードしたサイトで実行する必要がある。古いバージョンのドキュメントを含まな

い 新の DocuShare 6.6 のサイトでは、このコマンドを実行する必要はない。

有効なアップグレーダーは、バックグラウンドで、設定した時間の中で、アップグレードが完了するまで実行する。完了する前に何らかの理由で

アップグレードが中断しても、管理者はデータを失うことなくコマンドを再開することができる。

現在の設定を表示するには、オプションを指定しないでコマンドを実行する。このコマンドのデフォルトの設定は、enable off -starthour 1 -

endhour 6 である。

Server Statistics > Content Store Statistics を参照して、次のコマンド;Legacy Storage Performance Upgrade Enabled、 Legacy

Storage Performance Upgrade Completed の進捗を監視する。Content Store Statistics の Partitions テーブルの 後の 2 列は、それぞ

れのパーティションの状況を表す。Upgrade Completed は、パーティションのアップグレードの状況を表示し、Last Directory は、アップグレード

の進捗を表示する。Last Directory の値は、アップグレーダーがコンテンツストアディレクトリーを通して動作するときに定期的に変更される。

注:6.6 にアップグレードしたサイトで、コンテンツストアを分割する前にこのコマンドを使用する。管理者ガイドのコンテンツストア構成の手順を参照する。

setStorageUpgradeConfig のオプション

-h コマンドのヘルプを表示する。

-enable <on/off> ストレージアップグレーダーを有効または無効にする。

-endhour <hour> ストレージアップグレーダーを停止する時間(時:24 時間表記)をセットする。

-endminute <minute> ストレージアップグレーダーを停止する時間(分)をセットする。

-starthour <hour> ストレージアップグレーダーを開始する時間(時:24 時間表記)をセットする。

-startminute <minute> ストレージアップグレーダーを開始する時間(分)をセットする。

setStorageUpgradeConfig の使用例

setStorageUpgradeConfig -enable on -starthour 2 -endhour 7-アップグレーダーを有効にして、毎日 AM2:00 に開始し、AM7:00 に停

止する。

DocuShare Command Line Utilities Guide 2-55

Page 68: DocuShare コマンドラインユーティリティガイド

start_docushare DocuShare Commands

start_docushare

構文:start_docushare <引数>

start_docushare コマンドは、リリース 6 の起動とランタイム環境を制御する。

注:このコマンドの Tomcat 引数は dssetup コマンドに移行された。

start_docushare の引数

カッコ内は、引数に対するインストール時のデフォルト値を示する。

classes モニターは、<installdir>/tomcat/webapps/docushare/ WEB-IMF/classes をクラスパスの先頭に

付加する。

注意:DocuShare カスタマーサポートによる指示がある場合以外は、使用しない。

config <ファイル> モニターは<ファイル>をそのシステム構成に使用する。

console モニターは、Monitor.log ではなくコンソールにログを出力する。

debug モニターは、デバッグモードで稼働する。

注意:DocuShare カスタマーサポートによる指示がある場合以外は、使用しない。

env モニターは、Docushare ランタイム環境を表示させる。

force モニターは、新しい構成デフォルトファイルを作成する。

注意:DocuShare カスタマーサポートによる指示がある場合以外は、使用しない。

help コマンドのヘルプを表示する。

inprocess DSServer をプロセス内で実行する。

outprocess DSServer をプロセスの外で実行する(デフォルトは outprocess である)。

resetpassword admin のパスワードをデフォルトの admin にリセットする。

start サーバーを起動する(デフォルト設定)。

start_docushare.exe DocuShare を起動する Windows コマンド。単純な start_docushare コマンドと同一の機能。(開発

用)

trackrmi サブプロセスの接続をトラックする。

update_config モニターは、システム構成をアップデータするコントロールされたサービスを要求する。

update-only 環境の更新のみを実行し、終了する。

verbose モニターは、verbose モードで稼働する。

2–56 DocuShare Command Line Utilities Guide

Page 69: DocuShare コマンドラインユーティリティガイド

DocuShare Commands stop_docushare

stop_docushare

stop_docushare コマンドは、dsservice shutdown コマンドと同じ機能を提供する。つまり、DocuShare サービスを停止する。

stop_docushare コマンドは、ユーザーの便宜上用意されているものである。

stop_docushare のオプション

-h ヘルプ。コマンドのヘルプを表示する。

-q Quiet。コマンドを Quiet モードで実行する。すべての情報メッセージを抑制する。すべてのプロンプトに

対して、「はい」が入力されたものとみなし、その実行結果についてはユーザーの責任となる。

stop_docushare の引数 カッコ内は、引数に対するインストール時のデフォルト値を示す。

host <値> localhost のデフォルト以外の場合 RMI ホスト。

port <値> デフォルト 1099 以外の場合 RMI ポート。

quiet コマンドを Quiet モードで実行する。すべての情報メッセージを抑制する。すべてのプロンプトに対して、

「はい」が入力されたものとみなし、その実行結果についてはユーザーの責任となる。

help ヘルプ。コマンドのヘルプを表示する。

usage ヘルプを表示する。

verbose モニターは、verbose モードで稼働する。

Windows サーバーのみにおける注意点

stop_docushare コマンドは、DocuShare ディレクトリパス名が長すぎる場合は、実行されません。パス名が 18 文字を超えると、コ

マンドを実行することはできない。

コマンドのステータスを表示するには、エコーをオフに設定する。stop_docushare が実行されなかった場合は、ステータスの 初の部分にそ

れがエコー表示される。以下に例を示する。

The input line is too long

The syntax of the command is incorrect.

この場合には、stop_docushare の代わりに dsservice shutdown コマンドを用いて、DocuShare サービスを停止する。

DocuShare Command Line Utilities Guide 2–57

Page 70: DocuShare コマンドラインユーティリティガイド

DocuShare Commands

2–58 DocuShare Command Line Utilities Guide