Stockage de documents ARIS offre une série d'outils de ligne de commande pouvant être utilisés pour effectuer des opérations administratives.
ARIS doit être en marche.
Les outils de ligne de commande doivent être exécutés dans le chemin suivant :
chemin d'installation ARIS >/server/bin/work/word_adsadmin_<votre taille d'installation, par exemple, s, m ou l>/tools/bin pour les systèmes d'exploitation Windows®
et
chemin d'installation ARIS>/cloudagent/bin/work/work_adsadmin_<votre taille d'installation, par exemple, s, m ou l>/tools/bin pour les systèmes d'exploitation Linux
Veuillez utiliser y-admintool.bat pour les systèmes d'exploitation Windows et y-admintool.sh pour les systèmes d'exploitation Unix. Pour les systèmes d'exploitation Unix, les outils de ligne de commande (fichiers sh) ne peuvent être démarrés que par l'utilisateur aris10, par exemple, saisissez : su -c y-admintool.sh aris10.
Exemple
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
Utilisation générale
Options |
Description |
---|---|
-?, -h, --help |
Affiche l'aide, par défaut : false |
-s, --server |
URL du Stockage de documents ARIS |
-t, --tenant |
ID du locataire. La valeur par défaut est default. |
-umc, --umcserver |
URL de la Gestion des utilisateurs |
Commandes |
Description |
Paramètres |
---|---|---|
adjustTimestamps |
Modifie l'horodatage défini lors de la création et de la mise à jour des documents et des dossiers. L'horodatage est modifié pour tous les documents et dossiers d'un locataire. Usage : adjustTimestamps [options] |
--password (-p) <MOT DE PASSE> Le mot de passe par défaut est manager. --user (-u). Le nom d'utilisateur par défaut est system. * -offset Décalage à ajouter (+) ou à retirer (-) en minutes, par exemple : "-210". La valeur par défaut "0". |
anonymize |
Rend anonymes les informations d'utilisateur pour les documents et dossiers Usage : anonymize [options] Compatible avec le RGPD. Le règlement général européen de protection des données (RGPD, en anglais GDPR, General Data Protection Regulation) protège les données à caractère personnel des individus au sein de l'Union européenne. Il réglemente aussi l'exportation des données personnelles à l'extérieur de l'UE. Le RGPD est un règlement du Parlement européen, du Conseil de l'Union européenne et de la Commission européenne. |
--password (-p) <MOT DE PASSE> Mot de passe de l'éditeur. Le mot de passe par défaut est manager. Par défaut, aucun droit d'accès n'est défini dans le Stockage de documents ARIS. Tous les utilisateurs ont accès à tous les dossiers, y compris le dossier racine, et aux documents. Vous pouvez limiter l'accès à différents dossiers du Stockage de documents ARIS, pour que tous les utilisateurs du Stockage de documents ARIS ne puissent pas accéder à tous les dossiers et à leur contenu. Veuillez tenir compte des points suivants : Si vous supprimez un seul utilisateur de la liste des utilisateurs ou des groupes d'utilisateurs qui ont accès au dossier puis que vous rendez anonymes les données du dossier, toutes les actions en lien avec les données du dossier sont rendues anonymes. Autrement dit, l'anonymisation n'affecte pas que les données de l'utilisateur supprimé. Avant de supprimer un utilisateur, obtenir son ID d'utilisateur dans les détails d'utilisateur dans la gestion des utilisateurs. * -n, --name Nom de l'utilisateur ou du groupe d'utilisateurs * -type, --type Type de l'utilisateur ou du groupe d'utilisateurs -u, --user Nom d'utilisateur Mot de passe de l'éditeur. Le mot de passe par défaut est system. Le nom d'utilisateur est remplacé par la chaîne anonymous. |
bulkimport |
Importe tous les fichiers et dossiers d'un répertoire spécifié dans le Stockage de documents ARIS. La structure de dossier de la source est maintenue. Usage : bulkimport [options] Vous pouvez aussi importer d'importants jeux de données dans le Stockage de documents ARIS au moyen d'un rapport. Pour ce faire, veuillez contacter votre service local des ventes Software AG. |
-a, --attributes Crée des métadonnées pour chaque document chargé, par exemple : "description:chargement initial pour l'étape de migration|labels:big data,externe,projet|source:sharepoint". Cet exemple montre comment spécifier l'attribut Description et que des attributs personnalisés sont créés si les attributs requis ne sont pas disponibles par défaut (titre, description, balises, propriétaire). Le caractère | sert à séparer les valeurs. De ce fait, il ne peut pas être utilisé à l'intérieur d'une valeur. --password (-p) <MOT DE PASSE> Mot de passe de l'éditeur. Le mot de passe par défaut est manager. --repository (-r) <Repository name>. Le référentiel par défaut est le référentiel de portail utilisé dans Stockage de documents ARIS ou dans la vue de référentiel dans ARIS. La valeur par défaut est portal. Vous ne devez spécifier le référentiel par défaut qui si vous n'utilisez pas le référentiel par défaut. Un autre référentiel pourrait être le référentiel ARIS Risk and Compliance par exemple. -sw, --stopwatch Permet l'évaluation des performances pour l'importation en série de documents et dossiers. La valeur par défaut est false. --user (-u) <NOM D'UTILISATEUR> Nom d'utilisateur de l'éditeur. Le nom d'utilisateur par défaut est system. -deltaimportfile Importation des modifications : Importation delta : si des erreurs se sont produites lors de l'importation, le fichier importerrors.log est généré dans le répertoire de travail actuel, ../tools/bin/importerrors.log. Pour importer les documents répertoriés dans le fichier journal, veuillez saisir ce qui suit : |
-deltaimportfile "./importerrors.log". Dans ce cas, le paramètre de chemin est ignoré et seuls les fichiers disponibles dans le fichier importerrors.log sont importés. -logfile Définit le nom du fichier journal si vous utilisez le paramètre loglevel, par exemple %LOGS%adsimport.log. Si rien n'est défini, mais que la journalisation est activée (via le paramètre loglevel), le fichier adsimport.log est enregistré dans le répertoire de travail actuel. La valeur par défaut est adsimport.log. -loglevel Définit le niveau de log pour l'importation en série de documents. Utilisez standard pour ne consigner que les noms des documents et leurs ID. Utilisez hyperlinks pour consigner également les liens HTTP des documents. La valeur par défaut est none. * -path Chemin vers le répertoire devant être utilisé pour l'importation en série de documents (p. ex. C:/importation/documents/). La structure de répertoire du dernier dossier indiqué est reprise dans le référentiel du stockage de documents Stockage de documents ARIS. Exemple : Si le dossier source présente la structure C:/import/documents/dossier1/dossier2, l'exécution de l'outil de ligne de commande avec l'option -path génère la structure documents/dossier1/dossier2 dans Stockage de documents ARIS. |
||
-overwrite Si cette option est activée (-overwrite true), les documents et dossiers sont supprimés et nouvellement créés en fonction de la structure de répertoire spécifiée. * -path Chemin vers le répertoire à utiliser pour l'importation en série de documents (par exemple, C:/import/documents/). La structure de répertoire du dernier dossier indiqué est reprise dans le référentiel du stockage de documents Stockage de documents ARIS. Exemple : Si le dossier contenant les documents à importer présente la structure C:/import/documents/dossier1/dossier2, l'exécution de l'outil de ligne de commande avec l'option -path génère la structure documents/dossier1/dossier2 dans Stockage de documents ARIS. -toplevelfolder Si cette propriété est activée, le dossier supérieur défini à l'aide du paramètre -path est ignoré lors de l'importation. Si les documents à importer se trouvent dans un dossier mydocs et si le chemin /mydocs/dossier1/dossier2, par exemple, est utilisé avec cette option, seule la structure de dossier subordonnée au niveau mydocs sera reprise dans le stockage de documents Stockage de documents ARIS lors de l'importation et sera créée directement sous le répertoire racine. Si cette propriété n'est pas définie - cas par défaut - le dossier supérieur sera également repris dans le référentiel du stockage de documents Stockage de documents ARIS, c'est-à-dire que l'ensemble de la structure /mydocs/dossier1/dossier2 sera créée sous le répertoire racine. La valeur par défaut est false. |
||
deleteAccessPrivileges |
Supprime toutes les restrictions d'accès d'un dossier défini. Usage : deleteAccessPrivileges [options] |
--folderId (* -f) ID du dossier requis pour la suppression de tous les droits d'accès. --password (-p) <MOT DE PASSE> Le mot de passe par défaut est manager. --user (-u). Le nom d'utilisateur par défaut est system. --user (-u) <NOM D'UTILISATEUR> Nom d'utilisateur de l'éditeur. Le nom d'utilisateur par défaut est system. -orphandata Supprime les droits d'accès appartenant aux groupes d'accès supprimés. La valeur par défaut est false. -passon Supprime hiérarchiquement les droits d'accès dans le dossier. La valeur par défaut est false. |
exportConfig |
Exporte la configuration du Stockage de documents ARIS. Usage : exportConfig [options] |
--file (-f) Fichier de configuration. La valeur par défaut est adsConfig.properties. --password (-p) <MOT DE PASSE> Le mot de passe par défaut est manager. --user (-u). Le nom d'utilisateur par défaut est system. |
importConfig |
Met à jour la configuration du Stockage de documents ARIS de ce locataire. Usage : importConfig [options] |
--file ( -f) Fichier de configuration à importer. La valeur par défaut est adsConfig.properties. --password (-p) <MOT DE PASSE> Le mot de passe par défaut est manager. --user (-u). Le nom d'utilisateur par défaut est system. |
purgeAuditLog |
Purge tous les journaux d'audit pour l'utilisateur Administrateur sur la base de la période. La date de fin est obligatoire. La date doit respecter le format aaaa-MM-jj HH:mm:ss |
Usage : purgeAuditLog [options] Options : -s : URL du serveur -t : ID du locataire. La valeur par défaut est default. * -ed, --endDate Date de fin au format (yyyy-MM-dd HH:mm:ss) -u, --user Nom d'utilisateur de l'exécuteur, par défaut : system -p, --password Mot de passe de l'exécuteur, par défaut : manager -sd, --startDate Date de début au format (yyyy-MM-dd HH:mm:ss) Exemple 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 |
Réindexe la base de données Stockage de documents ARIS. Usage : reindex [options] |
--password (-p) <MOT DE PASSE> Le mot de passe par défaut est manager. --user (-u). Le nom d'utilisateur par défaut est system. |
thumbnails |
Crée des miniatures pour les images. Usage : thumbnails [options] |
--password (-p) <MOT DE PASSE> Mot de passe de l'éditeur. Le mot de passe par défaut est manager. --repository (-r) <Repository name>. Le référentiel par défaut est le référentiel de portail utilisé dans Stockage de documents ARIS ou dans la vue de référentiel dans ARIS. La valeur par défaut est portal. Vous ne devez spécifier le référentiel par défaut qui si vous n'utilisez pas le référentiel par défaut. Un autre référentiel pourrait être le référentiel ARIS Risk and Compliance par exemple. --user (-u) <NOM D'UTILISATEUR> Nom d'utilisateur de l'éditeur. Le nom d'utilisateur par défaut est system. |