alfresco-scripts

These are commonly used scripts which can be executed from java command line. There are services which can be consumed by any external apps/scripts if needed. These scripts uses Alfresco OOTB REST APIs.

Delete sites by excluding a list of sites (sites which you don't want to delete)

 java -cp alfresco-scripts-jar-with-dependencies.jar  com.github.abhinavmishra14.site.service.test.DeleteSites [HOST] [USER] [PASSWORD] [EXCLUDED_SITES_DEFAULT_COMMA_SEPARATED]
 

Delete site parameter information:

• HOST -> Is the alfresco host base web url e.g.: http://127.0.0.1:8080

• USER -> Is the user name for authentication. e.g.: admin

• PASSWORD -> Is the password for authentication

• EXCLUDED_SITES_DEFAULT_COMMA_SEPARATED -> Is the sites you want to exclude from deletion. e.g.: test-site, test-site2

Generate User report along with user groups as JSON.

OOTB Alfresco doesn't have direct API to do get all users along with their groups at once. Though you can get user profile of a particular user along with group. This report also includes information of all the sites which the user has access. Report is generated as a json. See the sample report here: samples/userReports.json

java -cp alfresco-scripts-jar-with-dependencies.jar com.github.abhinavmishra14.reports.test.GenerateUserReport [HOST] [USER] [PASSWORD]

Generate user report parameter information:

• HOST -> Is the alfresco host base web url e.g.: http://127.0.0.1:8080

• USER -> Is the user name for authentication. e.g.: admin

• PASSWORD -> Is the password for authentication

Cleanup trash can script

java -cp alfresco-scripts-jar-with-dependencies.jar com.github.abhinavmishra14.trashcan.service.test.ClearTrashcan [HOST] [USER] [PASSWORD] [BATCH_SIZE] [OLDER_THAN_NUM_OF_DAYS]

Delete trash can parameter information:

• HOST -> Is the alfresco host base web url e.g.: http://127.0.0.1:8080

• USER -> Is the user name for authentication. e.g.: admin

• PASSWORD -> Is the password for authentication

• BATCH_SIZE -> Number of items in one batch

• OLDER_THAN_NUM_OF_DAYS -> How many days older items needs deletion

Delete all tags script

java -cp alfresco-scripts-jar-with-dependencies.jar com.github.abhinavmishra14.tags.test.DeleteTags [HOST] [USER] [PASSWORD] [BATCH_SIZE]

Delete tags parameter information:

• HOST -> Is the alfresco host base web url e.g.: http://127.0.0.1:8080

• USER -> Is the user name for authentication. e.g.: admin

• PASSWORD -> Is the password for authentication

• BATCH_SIZE -> Number of items in one batch

Delete nodes based on given content url (Used database to query nodes based on content urls)

java -cp alfresco-scripts-jar-with-dependencies.jar com.github.abhinavmishra14.node.test.DeleteNodesBasedOnContentUrl [HOST] [USER] [PASSWORD] [CONTENTURLS_TXT_FILE] [DB_HOST] [DB_PORT] [DB_USER] [DB_PASSWORD]

Delete Nodes Based On ContentUrl parameter information:

• HOST -> Is the alfresco host base web url e.g.: http://127.0.0.1:8080

• USER -> Is the user name for authentication. e.g.: admin

• PASSWORD -> Is the password for authentication

• CONTENTURLS_TXT_FILE -> Filesystem path of a text file containing comma separated content urls in bulk. See sample text file here

• DB_HOST -> Is the database host to be used for JDBC URL. e.g.: 127.0.0.1/localhost/dev.postgres.com

• DB_PORT -> Is the database port to be used for JDBC URL. e.g.: 5432

• DB_USER -> Is the database user name to be used for JDBC URL. e.g.: alfresco

• DB_PASSWORD -> Is the database password to be used for JDBC URL. e.g.: alfresco

Upload files in parallel

java -cp alfresco-scripts-jar-with-dependencies.jar com.github.abhinavmishra14.upload.test.UploadTest [HOST] [USER] [PASSWORD] [SOURCE_FILEFOLDER_PATH] [PARENT_NODEID] [ADDITIONAL_MATADATA]

Upload test parameter information:

• HOST -> Is the alfresco host base web url e.g.: http://127.0.0.1:8080

• USER -> Is the user name for authentication. e.g.: admin

• PASSWORD -> Is the password for authentication

• SOURCE_FILEFOLDER_PATH -> Folder path which contains multiple files or a single file path. e.g.: C:\Users\Abhinav\Downloads

• PARENT_NODEID -> Parent Node Ref ID of the folder where content needs to be uploaded. e.g.: 4cccf037-03e9-49ff-93fe-a65f20bc0ff3

• ADDITIONAL_MATADATA -> Any additional metadata properties (comma separated) you want to apply while uploading the content. e.g.: cm:title=SampleTitle,cm:description=sample desc

Download Content

java -cp alfresco-scripts-jar-with-dependencies.jar com.github.abhinavmishra14.download.DownloadTest [HOST] [USER] [PASSWORD] [JSON_INPUT_OF_FILENAME_TO_NODEREF_MAPPING] [DOWNLOAD_LOCATION]

Download Content parameter information:

• HOST -> Is the alfresco host base web url e.g.: http://127.0.0.1:8080

• USER -> Is the user name for authentication. e.g.: admin

• PASSWORD -> Is the password for authentication

• JSON_INPUT_OF_FILENAME_TO_NODEREF_MAPPING -> A json input file that contains filename to nodeRef mapping. e.g. {"testImage.jpg": "workspace://SpacesStore/28626a0b-aeb8-44f2-bac3-0cbe41812f2c","testPdf.pdf": "workspace://SpacesStore/be8a752d-a24c-447e-866b-67948d01f25b"}

• DOWNLOAD_LOCATION -> A location on disk where content to be downloaded: C:\Users\Abhinav\Downloads

Download Content In Parallel

java -cp alfresco-scripts-jar-with-dependencies.jar com.github.abhinavmishra14.download.ParallelDownloadTest [HOST] [USER] [PASSWORD] [JSON_INPUT_OF_FILENAME_TO_NODEREF_MAPPING] [DOWNLOAD_LOCATION]

Download Content in parallel parameter information:

• HOST -> Is the alfresco host base web url e.g.: http://127.0.0.1:8080

• USER -> Is the user name for authentication. e.g.: admin

• PASSWORD -> Is the password for authentication

• JSON_INPUT_OF_FILENAME_TO_NODEREF_MAPPING -> A json input file that contains filename to nodeRef mapping. e.g. {"testImage.jpg": "workspace://SpacesStore/28626a0b-aeb8-44f2-bac3-0cbe41812f2c","testPdf.pdf": "workspace://SpacesStore/be8a752d-a24c-447e-866b-67948d01f25b"}

• DOWNLOAD_LOCATION -> A location on disk where content to be downloaded: C:\Users\Abhinav\Downloads

Search and Download Content + Metadata

java -cp alfresco-scripts-jar-with-dependencies.jar com.github.abhinavmishra14.download.SNDContentAndMetadataTest [HOST] [USER] [PASSWORD] [DOWNLOAD_LOCATION] [SEARCH_QUERY] [MAX_ITEMS] [SKIP_COUNT]

Search and Download Content + Metadata parameter information:

• HOST -> Is the alfresco host base web url e.g.: http://127.0.0.1:8080

• USER -> Is the user name for authentication. e.g.: admin

• PASSWORD -> Is the password for authentication

• DOWNLOAD_LOCATION -> A location on disk where content and metadata to be downloaded: C:\Users\Abhinav\Downloads

• SEARCH_QUERY -> A alfresco full text search query to search the repository. Make sure to pass the query in "" in case there are spaces between AND/OR queries when passing from command line as shown in the example. e.g.: "PATH:'/app:company_home/st:sites/cm:test-site/cm:documentLibrary//*' AND TYPE:'cm:content'".

• MAX_ITEMS -> Maximum number of items to fetch from search. e.g.: 1000. Defaults to 100.

• SKIP_COUNT -> Number of items to skip from search. e.g.: 0. Defaults to 0.

Search and Download Metadata Report as JSON

java -cp alfresco-scripts-jar-with-dependencies.jar com.github.abhinavmishra14.reports.test.SearchAndGenerateMetadataReport [HOST] [USER] [PASSWORD] [DOWNLOAD_LOCATION] [SEARCH_QUERY] [MAX_ITEMS] [SKIP_COUNT]

Search and Download Metadata report parameter information:

• HOST -> Is the alfresco host base web url e.g.: http://127.0.0.1:8080

• USER -> Is the user name for authentication. e.g.: admin

• PASSWORD -> Is the password for authentication

• DOWNLOAD_LOCATION -> A location on disk where content and metadata to be downloaded: C:\Users\Abhinav\Downloads

• SEARCH_QUERY -> A alfresco full text search query to search the repository. Make sure to pass the query in "" in case there are spaces between AND/OR queries when passing from command line as shown in the example. e.g.: "PATH:'/app:company_home/st:sites/cm:test-site/cm:documentLibrary//*' AND TYPE:'cm:content'".

• MAX_ITEMS -> Maximum number of items to fetch from search. e.g.: 1000. Defaults to 100.

• SKIP_COUNT -> Number of items to skip from search. e.g.: 0. Defaults to 0.

Generate Site User's Membership Report

java -cp alfresco-scripts-jar-with-dependencies.jar com.github.abhinavmishra14.site.service.test.GenerateSiteUsersMembershipReport [HOST] [USER] [PASSWORD] [SITE_SHORT_NAME]

Generate Site User's Membership Report parameter information:

• HOST -> Is the alfresco host base web url e.g.: http://127.0.0.1:8080

• USER -> Is the user name for authentication. e.g.: admin

• PASSWORD -> Is the password for authentication

• SITE_SHORT_NAME -> Is the sites you want to get the membership details. e.g.: test-site