ARIS 文書格納用コマンドライン ツール

ARIS 文書格納には、管理操作の実行に使用できるコマンドライン ツールのセットが用意されています。

Windows オペレーティング システムには y-admintool.bat を、Unix オペレーティング システムには y-admintool.sh を使用してください。 UNIX オペレーティング システムの場合、コマンドライン ツール (sh ファイル) を開始できるのは aris10 ユーザーのみです。たとえば、以下のように入力します。su -c y-admintool.sh aris10

y-admintool.bat -s http://my_aris_host.com:1080 -umc http://my_aris_host.com:1080 -t default bulkimport -u system -p manager -path d:\my_documents

全般用途

オプション

説明

-?、-h、--help

ヘルプを表示します。デフォルト: false

-s、--server

ARIS 文書格納の URL

-t、--tenant

テナントの ID。デフォルト値は「default」です。

-umc、--umcserver

ユーザー管理の URL

コマンド

説明

パラメーター

adjustTimestamps

文書とフォルダーを作成または更新する際に設定されるタイム スタンプを変更します。

テナントのすべての文書とフォルダーのタイム スタンプが変更されます。

使用: adjustTimestamps [options]

--password (-p) <パスワード>デフォルト パスワードは「manager」です。

--user (-u)デフォルトのユーザー名は system です。

* -offset

分単位で増 (+) 減 (-) させるオフセットです (例:

"-210")。デフォルト値は "0" です。

anonymize

文書とフォルダーのユーザー情報を匿名化します

使用: anonymize [options]

これは GDPR 準拠です。 EU 一般データ保護規則 (General Data Protection R、GDPR) は欧州連合内の個人データを保護します。また、EU 外への個人データの持ち出しも規制します。GDPR は欧州議会、欧州連合理事会、欧州委員会による規制です。

--password (-p) <パスワード>

実行者のパスワード。デフォルト パスワードは「manager」です。

デフォルトでは、ARIS 文書格納にアクセス権は定義されていません。すべてのユーザーは、ルート フォルダーを含むすべてのフォルダーと文書にアクセスできます。ARIS 文書格納の各フォルダーへのアクセスを制限して、すべての ARIS 文書格納ユーザーがすべてのフォルダーとその内容にアクセスすることがないようにできます。

注意:

ユーザー一覧またはフォルダーのアクセス権を持つユーザー グループから 1 人のユーザーのみを削除してからフォルダー データを匿名化すると、フォルダー データに関連するすべてのアクションが匿名化されます。つまり、匿名化は削除されたユーザーのデータに影響を与えるだけではありません。

ユーザーを削除する前に、ユーザー管理のユーザーの詳細から特定のユーザーのユーザー ID を取得してください。

* -n、--name

ユーザーまたはユーザー グループの名前

* -type、--type

ユーザーまたはユーザー グループのタイプ

-u、--user

ユーザー名

実行者のパスワード。デフォルト パスワードは「system」です。

ユーザー名は anonymous の文字列で置き換えられます。

bulkimport

指定されたディレクトリのすべてのファイルとフォルダーを、ARIS 文書格納にインポートします。ソースのフォルダー構造は維持されます。

使用: bulkimport [options]

また、レポートを使用して大きなデータセットを ARIS 文書格納にインポートすることもできます。そのためには、Software AG の営業担当までご連絡ください。

-a、--attributes

すべてのアップロードされた文書にメタデータを作成します (例: "description:initial upload for migration step|labels:big data,external,draft|source:sharepoint")。

この例は、[説明] 属性の指定方法と、デフォルトで必要な属性がない場合にカスタム属性が作成されることを示します (タイトル、説明、タグ、所有者)。「|」(縦線) は、値を区切るのに使用されます。ただし、値には使用できません。

--password (-p) <パスワード>

実行者のパスワード。デフォルト パスワードは「manager」です。

--repository (-r) <リポジトリ名>

デフォルト リポジトリは、ARIS 文書格納または ARIS のリポジトリ ビューで使用されるポータル リポジトリです。デフォルト値は portal です。

デフォルト リポジトリを使用しない場合のみ、ターゲット リポジトリを指定する必要があります。

別のリポジトリには、ARIS Risk and Compliance リポジトリなどが考えられます。

-sw、--stopwatch

文書とフォルダーの一括インポートのベンチマーキングを有効にします。

デフォルト値は false です。

--user (-u) <ユーザー名>

実行者のユーザー名。デフォルトのユーザー名は system です。

-deltaimportfile

デルタ インポート: インポート中にエラーが発生すると importerrors.log ファイルが現在の作業ディレクトリに作成されます (例: ../tools/bin/importerrors.log)。ログ ファイルに一覧が記載された文書をインポートするには、次のように指定します。

-deltaimportfile "./importerrors.log".

この場合、path パラメーターは無視され、importerrors.log ファイルで指定されたファイルのみがインポートされます。

-logfile

loglevel パラメーターが設定されている場合、ログ ファイルに使用される名前を指定します (例: %LOGS%adsimport.log)。

何も指定されていないが、loglevel パラメーターを使用したログ出力が有効な場合は、現在の作業ディレクトリに adsimport.log ファイルが保存されます。デフォルト値は adsimport.log です。

-loglevel

文書の一括インポートについてログ レベルを指定します。standard が設定されている場合は、文書の名前と ID のみがログに記録されます。hyperlinks が設定されている場合は、文書の HTTP リンクもログに記録されます。デフォルト値は none です。

* -path

文書の一括インポートに使用されるディレクトリ パスです (例: C:/import/documents/)。指定された最後のフォルダーから、ARIS 文書格納のリポジトリ構造にフォルダー構造が再成されます。

例: ソース フォルダーの構造が C:/import/documents/folder1/folder2 の場合、-path オプションを使用してこのコマンドライン ツールを実行すると、ARIS 文書格納に documents/folder1/folder2 構造が生成されます。

-overwrite

このオプションが有効な場合 (-overwrite true)、既存の文書とフォルダーが削除され、指定されたディレクトリ構造に従って新しく作成されます。

* -path

文書の一括インポートに使用されるディレクトリ パスです (例: C:/import/documents/)。指定された最後のフォルダーから、ARIS 文書格納のリポジトリ構造にフォルダー構造が再成されます。例: 文書がインポートされるソース フォルダーの構造が C:/import/documents/folder1/folder2 の場合、-path オプションを使用してこのコマンドライン ツールを実行すると、ARIS 文書格納に documents/folder1/folder2 構造が生成されます。

-toplevelfolder

このプロパティが設定されていると、-path パラメーターで指定されているトップレベル フォルダーはインポート中に無視されます。たとえば、インポートされる文書が mydocs フォルダーの下位レベルに配置されていて、このオプションとともに /mydocs/folder1/folder2 パスが使用された場合、インポート中に mydocs レベルの下位フォルダーの構造のみがミラーされ、ARIS 文書格納のルート ディレクトリの直下に作成されます。このプロパティが設定されていない場合 (それがデフォルトです)、トップレベル フォルダーが ARIS 文書格納リポジトリにミラーされます。つまり、/mydocs/folder1/folder2 の全体構造がルート ディレクトリの下に作成されます。 デフォルト値は false です。

deleteAccessPrivileges

すべてのアクセス制限を指定したフォルダーから削除します。

使用: deleteAccessPrivileges [options]

--folderId (* -f)

すべてのアクセス権を削除するには、フォルダー ID が必要です。

--password (-p) <パスワード>デフォルト パスワードは「manager」です。

--user (-u)デフォルトのユーザー名は system です。

--user (-u) <ユーザー名>

実行者のユーザー名。デフォルトのユーザー名は system です。

-orphandata

削除済みのユーザー グループに割り当てられているアクセス権を削除します。デフォルト値は false です。

-passon

フォルダーから階層的にアクセス権を削除します。 デフォルト値は false です。

exportConfig

ARIS 文書格納の設定をエクスポートします。

使用: exportConfig [options]

--file (-f)

設定ファイル。デフォルト値は adsConfig.properties です。

--password (-p) <パスワード>デフォルト パスワードは「manager」です。

--user (-u)デフォルトのユーザー名は system です。

importConfig

このテナントの ARIS 文書格納の設定を更新します。

使用: importConfig [options]

--file ( -f)

インポートされる設定ファイル。デフォルト値は adsConfig.properties です。

--password (-p) <パスワード>デフォルト パスワードは「manager」です。

--user (-u)デフォルトのユーザー名は system です。

purgeAuditLog

時間範囲に基づき、管理者ユーザーの監視ログを消去します。終了日は必須です。日付形式は yyyy-MM-dd Hh:mm:ss です。

使用: purgeAuditLog [options]

オプション:

-s: サーバーの URL

-t: テナントの ID。デフォルト値は「default」です。

* -ed、--endDate

終了日。形式は (yyyy-MM-dd HH:mm:ss)

-u、--user

実行者のユーザー名。デフォルト: system

-p、--password

実行者のパスワード。デフォルト: manager

-sd、--startDate

開始日。形式は (yyyy-MM-dd HH:mm:ss)

y-admintool.bat -s https://my_aris_host.com -t mytenant purgeAuditLog -sd "2021-05-22 00:00:00" -ed "2022-06-01 23:59:00" -u system -p manager

reindex

ARIS 文書格納データベースのインデックスを再付与します。

使用: reindex [options]

--password (-p) <パスワード>デフォルト パスワードは「manager」です。

--user (-u)デフォルトのユーザー名は system です。

thumbnails

画像のサムネイルを作成します。

使用: thumbnails [options]

--password (-p) <パスワード>

実行者のパスワード。デフォルト パスワードは「manager」です。

--repository (-r) <リポジトリ名>

デフォルト リポジトリは、ARIS 文書格納または ARIS のリポジトリ ビューで使用されるポータル リポジトリです。デフォルト値は portal です。

デフォルト リポジトリを使用しない場合のみ、ターゲット リポジトリを指定する必要があります。

別のリポジトリには、ARIS Risk and Compliance リポジトリなどが考えられます。

--user (-u) <ユーザー名>

実行者のユーザー名。デフォルトのユーザー名は system です。