ARIS document storage provides a set of command-line tools that can be used to perform administrative operations.
ARIS must be running.
The command-line tools must be executed in the following path:
<ARIS installation path>/server/bin/work/work_adsadmin_<your installation size, for example, s,m, or l>/tools/bin for Windows® operating systems
and
ARIS installation path>/cloudagent/bin/work/work_adsadmin_<your installation size, for example, s,m, or l>/tools/bin for Linux operating systems.
Please use y-admintool.bat for Windows operating systems and y-admintool.sh for Unix operating systems. For Unix operating systems, command-line tools (sh files) can only be started by the aris10 user, for example, enter: su -c y-admintool.sh aris10.
General usage
Options |
Description |
---|---|
-?, -h, --help |
Show help, default: false |
-s, --server |
URL of ARIS document storage |
-t, --tenant |
ID of the tenant. The default value is default. |
-umc, --umcserver |
URL of User Management |
Commands |
Description |
Parameters |
---|---|---|
adjustTimestamps |
Modifies the time stamp that is set while creating or updating documents and folders. The timestamp is modified for all documents and folders on a tenant. Usage: adjustTimestamps [options] |
--password (-p) <PASSWORD>. The default password is manager. --user (-u). The default user name is system. * -offset Offset to add (+) or to remove (-) in minutes, for example: "-210". The default value is "0". |
anonymize |
Anonymizes the user information for documents and folders Usage: anonymize [options] This is compliant to GDPR. The General Data Protection Regulation (GDPR) protects individuals’ personal data within the European Union. It also regulates the export of personal data outside the EU. GDPR is a regulation by the European Parliament, the Council of the European Union, and the European Commission. |
--password (-p) <PASSWORD> Password of the executor. The default password is manager. By default, no access privileges are defined in ARIS document storage. All users have access to all folders - including the root folder - and documents. You can limit the access to individual folders of ARIS document storage so that not all ARIS document storage users can access all folders and their contents. Please note: If you delete only one user from the user list or from user groups that have access to the folder and then anonymize the folder data, all actions related to the folder data are anonymized. This means that the anonymization does not only affect the data of the deleted user. Before you delete a user, get the user ID of a specific user from the user details in the user management. * -n, --name Name of the user or user group * -type, --type Type of the user or user group -u, --user User name Password of the executor. The default password is system. The user name is replaced by the string anonymous. |
bulkimport |
Imports all files and folders from a specified directory to ARIS document storage. The folder structure of the source is retained. Usage: bulkimport [options] Alternatively, you can import large datasets to ARIS document storage using a report. To do so, contact your local Software AG sales organization. |
-a, --attributes Creates metadata for every uploaded document, for example: "description:initial upload for migration step|labels:big data,external,draft|source:sharepoint". This example shows how to specify the Description attribute and that custom attributes are created if required attributes were not available by default (title, description, tags, owner). The character | is used to separate the values. However, it must not be used within a value. --password (-p) <PASSWORD> Password of the executor. The default password is manager. --repository (-r) <Repository name>. The default repository is the portal repository used in ARIS document storage or in the repository view in ARIS. The default value is portal. You must specify the target repository only if you do not use the default repository. A different repository could be the ARIS Risk and Compliance repository for example. -sw, --stopwatch Enables the benchmarking for bulk import of documents and folders. The default value is false. --user (-u) <USERNAME> User name of the executor. The default user name is system. -deltaimportfile Delta import: If errors have occurred during an import, an importerrors.log file is created in the current working directory, for example, ../tools/bin/importerrors.log. To import the documents listed in the log file, specify the following: |
-deltaimportfile "./importerrors.log". In this case, the path parameter is ignored, and only the files specified in the importerrors.log file are imported. -logfile Specifies the name to be used for the log file when the loglevel parameter is set, for example, %LOGS%adsimport.log. If nothing is specified, but logging is enabled using the loglevel parameter, the adsimport.log file is saved to the current working directory. The default value is adsimport.log. -loglevel Specifies the log level for the bulk import of documents. When set to standard, only document names and IDs are logged. When set to hyperlinks, the HTTP links of documents are also logged. The default value is none. * -path Directory path to be used for bulk import of documents, for example, C:/import/documents/. From the last folder specified, the folder structure is reproduced in the repository of ARIS document storage. Example: If the source folder has the following structure C:/import/documents/folder1/folder2, running the command-line tool using the -path option will generate the structure documents/folder1/folder2 in ARIS document storage. |
||
-overwrite If this option is enabled (-overwrite true), existing documents and folders are deleted and newly created according to the specified directory structure. * -path The directory path to be used for the bulk import of documents, for example, C:/import/documents/. From the last folder specified, the folder structure is reproduced in the repository of ARIS document storage. Example: If the folder containing the documents to be imported has the following structure C:/import/documents/folder1/folder2, running the command-line tool using the -path option will generate the structure documents/folder1/folder2 in ARIS document storage. -toplevelfolder If this property is set, the top-level folder specified in -path parameter is ignored during import. If the documents to be imported are located at a level lower than a given folder mydocs, and, for example, the path /mydocs/folder1/folder2 is used with this option, only the structure of the folders subordinate to the mydocs level is mirrored during the import and created directly below the root directory in ARIS document storage. If this property is not set (which is the default), the top-level folder is mirrored as well in the ARIS document storage repository, that is, the entire structure /mydocs/folder1/folder2 is created below the root directory. The default value is false. |
||
deleteAccessPrivileges |
Removes all access restrictions from a specified folder. Usage: deleteAccessPrivileges [options] |
--folderId (* -f) The folder ID is required to delete all access privileges. --password (-p) <PASSWORD>. The default password is manager. --user (-u). The default user name is system. --user (-u) <USERNAME> User name of the executor. The default user name is system. -orphandata Deletes the access privileges assigned to deleted user groups. The default value is false. -passon Deletes the access privileges from the folder hierarchically. The default value is false. |
exportConfig |
Exports the configuration of ARIS document storage. Usage: exportConfig [options] |
--file (-f) Configuration file. The default value is adsConfig.properties. --password (-p) <PASSWORD>. The default password is manager. --user (-u). The default user name is system. |
importConfig |
Updates the configuration of ARIS document storage of this tenant. Usage: importConfig [options] |
--file ( -f) The configuration file to be imported. The default value is adsConfig.properties. --password (-p) <PASSWORD>. The default password is manager. --user (-u). The default user name is system. |
reindex |
Re-indexes the ARIS document storage database. Usage: reindex [options] |
--password (-p) <PASSWORD>. The default password is manager. --user (-u). The default user name is system. |
thumbnails |
Creates thumbnails for pictures. Usage: thumbnails [options] |
--password (-p) <PASSWORD> Password of the executor. The default password is manager. --repository (-r) <Repository name>. The default repository is the portal repository used in ARIS document storage or in the repository view in ARIS. The default value is portal. You must specify the target repository only if you do not use the default repository. A different repository could be the ARIS Risk and Compliance repository for example. --user (-u) <USERNAME> User name of the executor. The default user name is system. |
Example
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