Teamwork Cloud is equipped with a Data Manager for administrative processes. You need to download the data manager .zip file and extract it to the machine where you installed Cassandra. Before using Data Manager, we recommend that you backup your database in the same manner as you do before using the migration tool. You can download the Data Manager tool from the same location you download the migration tools for the Cassandra database and UML meta-model.
Running the Data Manager
To run Data Manager
Stop the TWCloud server.
Note
If the command-line migration tool is running, it needs to be stopped as well.
Make sure Cassandra is up and running.
Note
The ports through which Data Manager is connected to Cassandra are 9160 and 9042.
Download DataManager.zip.
Extract the zip file to the machine where you installed Cassandra.
On the command line, change the directory to the DataManager folder.
Execute the following command to display all available commands:
Code Block
$ datamanager -help
Run the desired command, for example, to show the user list:
Code Block
datamanager -lu
Note
The Data Manager will connect to Cassandra on localhost using anonymous authentication. If your Cassandra node is configured to bind to a specific IP address (by default ports 9160 and 9042 bind to all interfaces), or if you have configured Cassandra to use an authenticator other than AllowAllAuthenticator, you will need to modify <installation_dir>/configuration/application.conf accordingly.
Info
The log file of Data Manager appears in the following directory:
<user folder>/.twcloud/2021x/datamanager.log
Data Manager commands
The following table outlines the commands you can use in Data Manager to manage your data.
Drops the 19.0 keyspace to free up the storage space after the database migration from 19.0 to 2021x.
Note
You can add --silent-drop to run the command silently, i.e., without requesting user permission.
You need to clear the removed keyspace snapshots using the nodetool utility command:
Code Block
nodetool clearsnapshot -- <keyspace>
-dr,--delete-resource <resource ID>
Deletes the given resource(s) and all of its related information. Specify multiple resource IDs using space as a separator.
Note
If you delete a synchronized resource from the target server, the resource will be removed together with its remote resource configuration allowing you to create new configurations with the same resource from the source server.
Deletes the given branch(es) and all of its related information. Specify multiple branch ID using a comma as a separator.
includeChildBranch has two values: true and false.
When the includeChildBranch value is set to false, andthe branch has child branches, this branch will not be deleted.
When the includeChildBranch value is set to true, the branch including its child branches will be deleted.
Note
This command does not work for the branches of a synchronized resource. You can delete only the whole synchronized resource, but not its branches.
-drd,--delete-marked-deleted-resources
Deletes all resources that were marked as deleted.
Note
If you delete a synchronized resource from the target server, the resource will be removed together with its remote resource configuration allowing you to create new configurations with the same resource from the source server.
Deletes the given revision(s) and all of its related information. Specify multiple revisions using a comma as a separator.
includeChildRevision has two values: true and false.
When the includeChildRevision value is set to false, and the revision is not the latest, it will not be deleted.
When the includeChildRevision value is set to true, the upward revisions and branches within it from the selected version will be deleted.
Note
This command does not work for the revisions of a synchronized resource. You can delete only the whole synchronized resource, but not its revisions.
-du,--delete-user <username>
Deletes the given username(s) and all of its related information. Specify multiple usernames using space as a separator.
Note
If the username consists of two words (for example, dan smith) you must add double quotation marks (" ") before and after the username, as shown in the following example:
Removes the read-only flag from a synchronized resource or category in the target server. Specify multiple resources or categories using a comma as a separator, for example:
Do not remove the read-only flag from periodically synchronized resources or categories. This will cause version inconsistencies after subsequent synchronizations.
The read-only flag removal is recommended only if resources or categories were moved to another server as a result of a one-time synchronization operation and you want to make them active again.
Lists all usernames and their information, sorted by name.
Note
You can add --no-info to show only the usernames.
-ram,--reset-administrator
Resets admin password, status, and permissions.
Note
If there is no Administrator account, it will be created.
If the Administrator account exists in the database:
If the account is for an external user, it will be reset to an internal user with a new password. This user will be shown in the TWCloud Admin console.
If the account is an internal user, only a new password will be generated, and the user will be shown in the TWCloud Admin console.
The default roles of the TWCloud Admin will be restored to make sure that this account can fully operate as the default administrator.
-rc,--recreate-cluster-id
Recreates a cluster ID.
-ri,--rebuild-index <data=value1,value2>
Rebuilds all indexes for the given data and uses the data=* option to rebuild all indexes of all available data.
-urd,--unmark-deleted-resources <resource ID>
Unmarks the given resource(s) previously marked as deleted. Specify multiple resource ID using space as a separator.