Check-in Client Examples

Here are some examples of using check-in client.

Here the Check-in Client is running in windows. If you are on Linux, you have to use checkin-client.sh instead. See Running Check-in Client.

For the username and the password, the default values "admin" "admin" are used. Please, replace them with your username and password when you are trying these commands.

Sample Scenario	Command to run
Checking out a root collection from a remote registry running on https://localhost:9443 to the current working directory. For tenant users use https://localhost:9443/t/tenant_domain where tenant_domain is the domain name of the tenant.	`checkin-client.bat co` `https://localhost:9443/registry/` `-u admin -p admin_pw` `checkin-client.bat co` `https://localhost:9443/t/tenant_domain/registry/` `-u tenant_user -p tenant_user_pw`
Checking in a collection from the current working directory back to the registry which it check out (This command is independent of whether it is checked out from a local registry or a remote registry. It will anyway commit it back to where it is checked out from).	`checkin-client.bat ci -u admin -p admin_pw` `checkin-client.bat ci -u tenant_user -p tenant_user_pw`
Checking in a collection from given working directory (path) back to the registry which it check out (This command is independent of whether it is checked out from a local registry or a remote registry. It will anyway commit it back to where it is checked out from).	`checkin-client.bat path ci -u admin -p admin_pw` `checkin-client.bat path ci -u tenant_user -p tenant_user_pw`
Dump a remote registry "/path" collection to a file. It is recommended that you check out from child collection paths (/_system/governance/trunk). Notice the additional `-f` option	`checkin-client.bat co https://localhost:9443/registry/path -u admin -p admin_pw -f remote.dump` `checkin-client.bat co https://localhost:9443/t/tenant_domain/registry/path -u tenant_user -p tenant_user_pw -f remote.dump`
Restore a dump file to a remote registry "/path" collection. It is recommended that you check out from child collection paths (e.g. `/_system/governance/trunk`), since check out and check in from the top level collection paths (i.e. `/_system/governance/` and `/_system/config/)` are not supported. Provide the URL with the `ci` command. See The Check-in Client Commands.	`checkin-client.bat ci https://localhost:9443/registry/path -u admin -p admin_pw -f remote.dump` `checkin-client.bat ci https://localhost:9443/t/tenant_domain/registry/path -u tenant_user -p tenant_user_pw -f remote.dump`
Copy entire tree from "`/path1"` to "`/path2"` using the check-in client. This can be done through the `copy` command alternatively. See The Check-in Client Commands.	`checkin-client.bat co https://localhost:9443/registry/ path1 -u admin -p admin_pw -f temp.dump` `checkin-client.bat ci https://localhost:9443/registry/path2 -u admin -p admin_pw -f temp.dump`
Copy entire collection from Governance Registry 1 (runs on 9443 port) to Governance Registry 2 (runs on 9444 port) using the check-in client. This method cannot be used to restore the root of the registry. To restore the root, use the check-in client dump to file system method.	`checkin-client.bat co https://localhost:9443/registry/path1 -u admin -p admin_pw -f temp.dump` `checkin-client.bat ci https://localhost:9444/registry/path1 -u admin -p admin_pw -f temp.dump`
Add the media type when checking in a file.	`sh ../checkin-client.sh add file.xml --mediatype application/xml -u admin -p admin`