### Install Dependencies and Start Application Source: https://github.com/alfresco/docs-alfresco/blob/master/digital-workspace/latest/develop/manage.md Install project dependencies using npm ci and start the Digital Workspace application with the content-ee distribution. ```bash npm ci npm start content-ee ``` -------------------------------- ### Start Process Services on Linux Source: https://github.com/alfresco/docs-alfresco/blob/master/process-services/latest/install/manual.md Navigate to the installation directory and run this script to start the Process Services application on Linux. ```bash ./start-process-services.sh ``` -------------------------------- ### Install AMP module Source: https://github.com/alfresco/docs-alfresco/blob/master/content-services/latest/develop/extension-packaging.md Usage syntax and example for installing an AMP file into a target WAR file. ```bash usage: install [options] valid options: -verbose : enable verbose output -directory : indicates that the amp file location specified is a directory. All amp files found in the directory and its sub directories are installed. -force : forces installation of AMP regardless of currently installed module version -preview : previews installation of AMP without modifying WAR file -nobackup : indicates that no backup should be made of the WAR ``` ```bash java -jar alfresco-mmt-2.1.0.jar install /root/alfresco-recordsmanagement-2.1.0.amp /usr/jboss-4.0.3SP1/server/default/deploy/alfresco.war ``` -------------------------------- ### Verify JRebel Initialization Source: https://github.com/alfresco/docs-alfresco/blob/master/content-services/latest/develop/sdk.md Example log output confirming that the JRebel agent has successfully started. ```text 2023-06-27 15:28:12 JRebel: Starting logging to file: /home/alfresco/.jrebel/jrebel.log 2023-06-27 15:28:12 JRebel: 2023-06-27 15:28:12 JRebel: ############################################################# 2023-06-27 15:28:12 JRebel: 2023-06-27 15:28:12 JRebel: JRebel Agent 7.0.8 (999999999999) 2023-06-27 15:28:12 JRebel: (c) Copyright ZeroTurnaround AS, Estonia, Tartu. 2023-06-27 15:28:12 JRebel: 2023-06-27 15:28:12 JRebel: Over the last 2 days JRebel prevented 2023-06-27 15:28:12 JRebel: at least 1 redeploys/restarts saving you about 0 hours. 2023-06-27 15:28:12 JRebel: 2023-06-27 15:28:12 JRebel: Licensed to XXXX XXXX (XXXX) 2023-06-27 15:28:12 JRebel: 2023-06-27 15:28:12 JRebel: License type: evaluation 2023-06-27 15:28:12 JRebel: Valid from: XXX 99, 9999 2023-06-27 15:28:12 JRebel: Valid until: XXX 99, 9999 2023-06-27 15:28:12 JRebel: 2023-06-27 15:28:12 JRebel: You are using an EVALUATION license. 2023-06-27 15:28:12 JRebel: Days left until license expires: 99 2023-06-27 15:28:12 JRebel: 2023-06-27 15:28:12 JRebel: To extend your evaluation or purchase a license, 2023-06-27 15:28:12 JRebel: contact sales@zeroturnaround.com. 2023-06-27 15:28:12 JRebel: 2023-06-27 15:28:12 JRebel: If you think this is an error, contact support@zeroturnaround.com. 2023-06-27 15:28:12 JRebel: 2023-06-27 15:28:12 JRebel: 2023-06-27 15:28:12 JRebel: ############################################################# ``` -------------------------------- ### Start and Status Scripts for LibreOffice Source: https://github.com/alfresco/docs-alfresco/blob/master/transform-service/latest/install/index.md These commands are used to start and check the status of the LibreOffice service. Replace {installdir} with your actual LibreOffice installation directory. ```bash start ex. {installdir}/libreoffice/scripts/libreoffice_ctl.sh start ``` ```bash status ex. {installdir}/libreoffice/scripts/libreoffice_ctl.sh status ``` -------------------------------- ### Start Sync Service with Authenticated JMX Source: https://github.com/alfresco/docs-alfresco/blob/master/sync-service/latest/config/jmx.md Example command to launch the Sync Service with JMX authentication enabled. ```java java -Xmx2G -Dcom.sun.management.jmxremote=true -Djava.rmi.server.hostname=34.253.209.238 -Dcom.sun.management.jmxremote.port=50800 -Dcom.sun.management.jmxremote.rmi.port=50801 -Dcom.sun.management.jmxremote.authenticate=true -Dcom.sun.management.jmxremote.password.file=/path/to/jmx.password -Dcom.sun.management.jmxremote.ssl=false -Djava.io.tmpdir=/var/tmp/dsync -cp postgresql.jar:service-sync-5.0.x.jar org.alfresco.service.sync.dropwizard.SyncService server config.yml ``` -------------------------------- ### Module list output Source: https://github.com/alfresco/docs-alfresco/blob/master/governance-services/latest/install/uninstall.md Example output showing installed Governance Services modules. ```text Module 'org_alfresco_module_rm' installed in 'webapps/alfresco' - Title: AGS Repo - Version: 23.1 - Install Date: null - Description: Alfresco Governance Services Repository Extension Module 'alfresco-rm-enterprise-repo' installed in 'webapps/alfresco' - Title: AGS Enterprise Repo - Version: 23.1 - Install Date: Thurs Nov 02 08:50:15 UTC 2023 - Description: Alfresco Governance Services Enterprise Repository Extension ``` ```text Module 'alfresco-rm-enterprise-share' installed in 'tomcat\webapps\share.war' - Title: Alfresco Record Management Share Extension - Version: 23.1 - Install Date: Thurs Nov 02 08:50:15 UTC 2023 - Description: Alfresco Record Management Share Extension ``` -------------------------------- ### ActiveMQ Startup Log Example Source: https://github.com/alfresco/docs-alfresco/blob/master/content-services/latest/develop/oop-sdk.md Example log output showing Apache ActiveMQ starting up. Note the ActiveMQ Broker TCP access point, which is required for configuring event applications. ```text activemq_1 | INFO | Apache ActiveMQ 5.18.3 (localhost, ID:34b213aab4c7-42881-1706185256201-0:1) is starting activemq_1 | INFO | Listening for connections at: tcp://34b213aab4c7:61616?maximumConnections=1000&wireFormat.maxFrameSize=104857600 ... ``` -------------------------------- ### Install Project Dependencies Source: https://github.com/alfresco/docs-alfresco/blob/master/digital-workspace/latest/develop/manage.md Installs all necessary project dependencies using npm. This command should be run before starting or building the application. ```bash npm install ``` -------------------------------- ### Launch Content Services Node Source: https://github.com/alfresco/docs-alfresco/blob/master/media-management/latest/config/start.md Execute this command to start the content services node. Replace `x.x.x` with the actual JAR file version. The node requires correctly installed ImageMagick and FFmpeg to start. ```bash java -jar content-services-node-x.x.x.jar server config.yml ``` -------------------------------- ### Start Sync Service with Insecure JMX Source: https://github.com/alfresco/docs-alfresco/blob/master/sync-service/latest/config/jmx.md Example command to launch the Sync Service with JMX enabled and security disabled. ```java java -Xmx2G -Dcom.sun.management.jmxremote=true -Djava.rmi.server.hostname=34.253.209.238 -Dcom.sun.management.jmxremote.port=50800 -Dcom.sun.management.jmxremote.rmi.port=50801 -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false -Djava.io.tmpdir=/var/tmp/dsync -cp postgresql.jar:service-sync-5.0.x.jar org.alfresco.service.sync.dropwizard.SyncService server config.yml ``` -------------------------------- ### Verify Startup Logs Source: https://github.com/alfresco/docs-alfresco/blob/master/governance-services/latest/install/docker.md Example output indicating successful server startup. ```text ... alfresco_1 | ... INFO ... [main] org.apache.coyote.AbstractProtocol.start Starting ProtocolHandler ["http-nio-8080"] alfresco_1 | ... INFO ... [main] org.apache.coyote.AbstractProtocol.start Starting ProtocolHandler ["ajp-nio-8009"] alfresco_1 | ... INFO ... [main] org.apache.catalina.startup.Catalina.start Server startup in 226026 ms ``` -------------------------------- ### Timer Start Event XML Example Source: https://github.com/alfresco/docs-alfresco/blob/master/process-automation/latest/model/processes/bpmn.md XML configuration for a timer start event with a timeCycle property. This example specifies 10 repetitions at 12-hour intervals, starting on December 10th, 2020. ```xml SequenceFlow_1 R10/2020-12-10T13:00/PT12H ``` -------------------------------- ### View Container Creation Logs Source: https://github.com/alfresco/docs-alfresco/blob/master/content-services/latest/install/containers/docker-compose.md Example output showing the initialization of various services and networks. ```text ... Creating network "acs_trial_default" with the default driver Creating volume "acs_trial_shared-file-store-volume" with default driver Creating acs_trial_control-center_1 ... done Creating acs_trial_activemq_1 ... done Creating acs_trial_sync-service_1 ... done Creating acs_trial_solr6_1 ... done Creating acs_trial_digital-workspace_1 ... done Creating acs_trial_share_1 ... done Creating acs_trial_postgres_1 ... done Creating acs_trial_alfresco_1 ... done Creating acs_trial_shared-file-store_1 ... done Creating acs_trial_proxy_1 ... done Creating acs_trial_transform-router_1 ... done Creating acs_trial_transform-core-aio_1 ... done Attaching to acs_trial_postgres_1, acs_trial_control-center_1, acs_trial_sync-service_1, acs_trial_share_1, acs_trial_digital-workspace_1, acs_trial_alfresco_1, acs_trial_solr6_1, acs_trial_activemq_1, acs_trial_shared-file-store_1, acs_trial_proxy_1, acs_trial_transform-router_1, acs_trial_transform-core-aio_1 ... ``` -------------------------------- ### Install Dependencies and Start Content App Source: https://github.com/alfresco/docs-alfresco/blob/master/digital-workspace/latest/develop/deploy.md Install the necessary Node.js dependencies and start the Alfresco Content App in development mode. The application will be available at http://localhost:4200. ```bash npm install npm start ``` -------------------------------- ### ACL Examples - Get Permissions Source: https://github.com/alfresco/docs-alfresco/blob/master/federation-services/latest/config/index.md Example of how to retrieve ACLs for an S3 object. ```APIDOC ## ACL Examples - Get Permissions ### Description This endpoint retrieves the Access Control Lists (ACLs) for a specified S3 object. ### Method GET ### Endpoint `/api/repo/s3/acls` ### Query Parameters - **id** (string) - Required - The full S3 path of the object in the format `/bucket/key`. ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **results** (array) - A list of ACL strings, each representing a grantee and their permissions. ### Response Example ```json { "success": true, "results": [ "7cfbdbb50b0682227896f2b416777d4d74906ded4df472db3ace75768962c134:(adminuser):FULL_CONTROL" ] } ``` ``` -------------------------------- ### Initialize Folder and Document Source: https://github.com/alfresco/docs-alfresco/blob/master/content-services/latest/develop/reference/cmis-ref.md Example usage of the createFolder and createDocument methods. ```java Folder folder = cmisClient.createFolder(session); Document document = cmisClient.createDocument(session, folder); ``` -------------------------------- ### Run Linux Setup Wizard Source: https://github.com/alfresco/docs-alfresco/blob/master/process-services/latest/install/manual.md Execute this command in the terminal to launch the Process Services setup wizard on Linux. ```bash ./ ``` -------------------------------- ### Example GET Request with Authorization Header Source: https://github.com/alfresco/docs-alfresco/blob/master/process-services/latest/develop/rest-api.md This example demonstrates how to call the `app-version` REST API using a GET request, including the necessary `Authorization` header with a bearer token. ```http GET /activiti-app/api/enterprise/app-version HTTP/1.1 Host: activiti.example.com Authorization: Bearerd1c7dc0b-b1e1-4039-923e-55199473bd5b ``` -------------------------------- ### Start Development Server Source: https://github.com/alfresco/docs-alfresco/blob/master/digital-workspace/latest/develop/deploy.md Start the application's development server using npm start. The application will automatically open in your browser at http://localhost:4200. ```bash npm start ``` -------------------------------- ### Start ActiveMQ Source: https://github.com/alfresco/docs-alfresco/blob/master/transform-service/latest/install/index.md Execute this command from the ActiveMQ installation directory to start the message broker. ```bash bin/activemq start ``` -------------------------------- ### Complete Metadata Configuration Example Source: https://github.com/alfresco/docs-alfresco/blob/master/microsoft-outlook/latest/config/index.md A comprehensive example demonstrating folder-based matching for various metadata scenarios, including numeric, list-based, and standard property configurations. ```xml
``` -------------------------------- ### Get Type Columns Response Source: https://github.com/alfresco/docs-alfresco/blob/master/federation-services/latest/config/index.md Example JSON response for the GET /api/repo/graph/typeDef endpoint. ```text { "success": true, "results": { "siteId": "simflofy.sharepoint.com,bfc93f6e-6eed-4f27-8aa8-72509a410d3b,a357fae5-24f9-464c-8087-cc1594eed1d4", "parentId": "0x0101009BF5E42EF312544B9224A53A7FF98D60", "properties": [ {.....}, { "Display Name": "3SixtyDate", "Min Value": 0, "Options": [], "Max Value": 0, "Description": "", "Property Type": "DATETIME", "Value": "", "Id": "3SixtyDate", "Is Required": false, "Is Read Only": false }, { "Display Name": "3SixtyNumber", "Min Value": 0, "Options": [], "Max Value": 0, "Description": "", "Property Type": "LONG", "Value": "", "Id": "3SixtyNumber", "Is Required": false, "Is Read Only": false }, { "Display Name": "3SixtyText", "Min Value": 0, "Options": [], "Max Value": 0, "Description": "", "Property Type": "TEXT", "Value": "", "Id": "3SixtyText", "Is Required": false, "Is Read Only": false } ] } } ``` -------------------------------- ### Get Library Types Response Source: https://github.com/alfresco/docs-alfresco/blob/master/federation-services/latest/config/index.md Example JSON response for the GET /api/repo/graph/types endpoint. ```text { "success": true, "results": { .... "Task": "0x0108", "Invoice": "0x0101006248104F6C684C46B570A09939521E3A", "Issue": "0x0103", "MetaFolder": "0x012000AB92FFACCC027F4289957CAC503C4F63", "Workflow Task": "0x010801", "Timecard": "0x0100C30DDA8EDB2E434EA22D793D9EE42058", "Holiday": "0x01009BE2AB5291BF4C1A986910BD278E4F18", "MetaDocument": "0x0101009BF5E42EF312544B9224A53A7FF98D60…..", "Schedule": "0x0102007DBDC1392EAF4EBBBF99E41D8922B264", ... } } ``` -------------------------------- ### Build and run the application Source: https://github.com/alfresco/docs-alfresco/blob/master/content-services/latest/develop/oop-sdk.md Commands to package the application and execute the resulting JAR file. ```bash $ mvn clean package -Dlicense.skip=true [INFO] Scanning for projects... ... $ java -jar target/rest-api-0.0.1-SNAPSHOT.jar . ____ _ __ _ _ /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ \\/ ___)| |_)| | | | | || (_| | ) ) ) ) ' |____| .__|_| |_|_| |_\__, | / / / / =========|_|==============|___/=/_/_/_/ :: Spring Boot :: (v2.4.2) 2021-04-07 14:31:35.599 INFO 53273 --- [ main] o.a.tutorial.restapi.RestApiApplication : Starting RestApiApplication v0.0.1-SNAPSHOT using Java 11.0.2 on MBP512-MBERGLJUNG-0917 with PID 53273 (/Users/mbergljung/IDEAProjects/docs-new/sdk5/sdk5-rest-api-java-wrapper-sample/target/rest-api-0.0.1-SNAPSHOT.jar started by mbergljung in /Users/mbergljung/IDEAProjects/docs-new/sdk5/sdk5-rest-api-java-wrapper-sample) 2021-04-07 14:31:35.605 INFO 53273 --- [ main] o.a.tutorial.restapi.RestApiApplication : No active profile set, falling back to default profiles: default 2021-04-07 14:31:36.832 INFO 53273 --- [ main] o.s.cloud.context.scope.GenericScope : BeanFactory id=55661aff-d1dc-3db8-94e2-cf0514d3118c 2021-04-07 14:31:37.443 INFO 53273 --- [ main] o.a.tutorial.restapi.RestApiApplication : Started RestApiApplication in 2.832 seconds (JVM running for 3.563) ``` -------------------------------- ### Get Start Form for Process Definition Source: https://github.com/alfresco/docs-alfresco/blob/master/process-services/latest/develop/rest-api.md Retrieves the start form for a process definition if it has one. ```APIDOC ## GET /api/enterprise/process-definitions/{processDefinitionId}/start-form ### Description Retrieves the start form for a process definition if it has one. ### Method GET ### Endpoint /api/enterprise/process-definitions/{processDefinitionId}/start-form ### Path Parameters - **processDefinitionId** (string) - Required - The ID of the process definition to get the start form for. ### Response #### Success Response (200) - **processDefinitionId** (string) - The ID of the process definition. - **processDefinitionName** (string) - The name of the process definition. - **processDefinitionKey** (string) - The key of the process definition. - **fields** (array) - An array of form field representations. - **fieldType** (string) - The type of the form field (e.g., 'ContainerRepresentation', 'DynamicTableRepresentation'). - **id** (string) - The ID of the form field. - **name** (string) - The name of the form field. - **type** (string) - The data type of the form field. - **value** (any) - The default value of the form field. - **required** (boolean) - Whether the field is required. - **readOnly** (boolean) - Whether the field is read-only. - **overrideId** (boolean) - Whether the field ID can be overridden. - **placeholder** (string) - Placeholder text for the field. - **optionType** (string) - The type of options for the field. - **hasEmptyValue** (boolean) - Indicates if the field has an empty value. - **options** (array) - List of options for the field. - **restUrl** (string) - REST URL for fetching options. - **restIdProperty** (string) - Property name for the ID in REST options. - **restLabelProperty** (string) - Property name for the label in REST options. - **layout** (object) - Layout information for the field. - **sizeX** (integer) - Width of the field in the layout. - **sizeY** (integer) - Height of the field in the layout. - **row** (integer) - Row position in the layout. - **col** (integer) - Column position in the layout. - **visibilityCondition** (object) - Condition for field visibility. - **fields** (object) - Nested fields for container types. - **columnDefinitions** (array) - Column definitions for dynamic tables. - **outcomes** (array) - An array of possible outcomes for the form. ### Response Example ```json { "processDefinitionId": "p1:2:2504", "processDefinitionName": "p1", "processDefinitionKey": "p1", "fields": [ { "fieldType": "ContainerRepresentation", "id": "container1", "name": null, "type": "container", "value": null, "required": false, "readOnly": false, "overrideId": false, "placeholder": null, "optionType": null, "hasEmptyValue": null, "options": null, "restUrl": null, "restIdProperty": null, "restLabelProperty": null, "layout": null, "sizeX": 0, "sizeY": 0, "row": 0, "col": 0, "visibilityCondition": null, "fields": { "1": [ { "fieldType": "FormFieldRepresentation", "id": "label1", "name": "Label1", "type": "text", "value": null, "required": false, "readOnly": false, "overrideId": false, "placeholder": null, "optionType": null, "hasEmptyValue": null, "options": null, "restUrl": null, "restIdProperty": null, "restLabelProperty": null, "layout": { "row": 0, "column": 0, "colspan": 1 }, "sizeX": 1, "sizeY": 1, "row": 0, "col": 0, "visibilityCondition": null } ], "2": [ ] } }, { "fieldType": "DynamicTableRepresentation", "id": "label21", "name": "Label 21", "type": "dynamic-table", "value": null, "required": false, "readOnly": false, "overrideId": false, "placeholder": null, "optionType": null, "hasEmptyValue": null, "options": null, "restUrl": null, "restIdProperty": null, "restLabelProperty": null, "layout": { "row": 10, "column": 0, "colspan": 2 }, "sizeX": 2, "sizeY": 2, "row": 10, "col": 0, "visibilityCondition": null, "columnDefinitions": [ { "id": "p2", "name": "c2", "type": "String", "value": null, "optionType": null, "options": null, "restUrl": null, "restIdProperty": null, "restLabelProperty": null, "required": true, "editable": true, "sortable": true, "visible": true } ] } ], "outcomes": [ ] } ``` ``` -------------------------------- ### Maven Build Output Example Source: https://github.com/alfresco/docs-alfresco/blob/master/content-services/latest/develop/sdk.md This is an example of the Maven build output when running the './run.sh build_start' command, showing the reactor build order and summary. ```bash [INFO] Scanning for projects... [WARNING] The project com.example:my-all-in-one-project:pom:1.0-SNAPSHOT uses prerequisites which is only intended for maven-plugin projects but not for non maven-plugin projects. For such purposes you should use the maven-enforcer-plugin. See https://maven.apache.org/enforcer/enforcer-rules/requireMavenVersion.html [INFO] ------------------------------------------------------------------------ [INFO] Reactor Build Order: [INFO] AIO - SDK 4.8 [INFO] Alfresco Platform/Repository JAR Module [INFO] Alfresco Share JAR Module [INFO] Integration Tests Module [INFO] Alfresco Platform/Repository Docker Module [INFO] Alfresco Share Docker Module ... [INFO] ------------------------------------------------------------------------ [INFO] Reactor Summary for AIO - SDK 4.8 1.0-SNAPSHOT: [INFO] AIO - SDK 4.8 ...................................... SUCCESS [01:27 min] [INFO] Alfresco Platform/Repository JAR Module ............ SUCCESS [17:41 min] [INFO] Alfresco Share JAR Module .......................... SUCCESS [02:04 min] [INFO] Integration Tests Module ........................... SUCCESS [ 0.431 s] [INFO] Alfresco Platform/Repository Docker Module ......... SUCCESS [02:01 min] [INFO] Alfresco Share Docker Module ....................... SUCCESS [ 0.077 s] [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ ... ``` -------------------------------- ### Get S3 ACLs Example Source: https://github.com/alfresco/docs-alfresco/blob/master/federation-services/latest/config/index.md This example demonstrates how to retrieve Access Control Lists (ACLs) for an S3 object using a GET request. The response includes the success status and a list of ACL entries. ```text GET /api/repo/s3/acls?id=/test-bucket/archive/testdoc.txt ``` ```json { "success": true, "results": [ "7cfbdbb50b0682227896f2b416777d4d74906ded4df472db3ace75768962c134:(adminuser):FULL_CONTROL" ] } ``` -------------------------------- ### Start Search and Insight Engine (Single Instance) Source: https://github.com/alfresco/docs-alfresco/blob/master/insight-engine/latest/install/options.md Command to start a single instance of Search and Insight Engine with custom JVM parameters for core creation and SSL configuration. Ensure this is run only the first time to create default cores. ```bash cd alfresco-insight-engine ./solr/bin/solr start -a "-Dcreate.alfresco.defaults=alfresco,archive -Dsolr.ssl.checkPeerName=false -Dsolr.allow.unsafe.resourceloading=true -Dssl-keystore.password=keystore -Dssl-keystore.aliases=ssl-alfresco-ca,ssl-repo-client -Dssl-keystore.ssl-alfresco-ca.password=keystore -Dssl-keystore.ssl-repo-client.password=keystore -Dssl-truststore.password=truststore -Dssl-truststore.aliases=ssl-alfresco-ca,ssl-repo,ssl-repo-client -Dssl-truststore.ssl-alfresco-ca.password=truststore -Dssl-truststore.ssl-repo.password=truststore -Dssl-truststore.ssl-repo-client.password=truststore" -f ``` -------------------------------- ### Start Identity Service Source: https://github.com/alfresco/docs-alfresco/blob/master/identity-service/latest/install/zip/index.md Execute the start script from the bin directory. Ensure placeholders like are replaced with actual values. ```bash $ cd alfresco-identity-service-2.0.0/bin $ ./kc.sh start --import-realm --http-relative-path="/auth" --hostname= --https-certificate-file= --https-certificate-key-file= $ # alternatively, without HTTPS: $ ./kc.sh start --import-realm --http-relative-path="/auth" --hostname= --http-enabled=true --hostname-strict-https=false ``` ```batch ...\alfresco-identity-service-2.0.0\bin\kc.bat start --import-realm --http-relative-path="/auth" --hostname= --https-certificate-file= --https-certificate-key-file= :: alternatively, without HTTPS: ...\alfresco-identity-service-2.0.0\bin\kc.bat start --import-realm --http-relative-path="/auth" --hostname= --http-enabled=true --hostname-strict-https=false ``` -------------------------------- ### Define a BPMN start event in XML Source: https://github.com/alfresco/docs-alfresco/blob/master/process-automation/latest/model/processes/bpmn.md Examples of XML definitions for start events, with and without an associated form. ```xml SequenceFlow_1 ``` ```xml SequenceFlow_1 ``` -------------------------------- ### Create a Site via cURL Source: https://github.com/alfresco/docs-alfresco/blob/master/content-services/latest/develop/rest-api-guide/sites.md Example command to create a public site named 'My Stuff'. ```bash $ curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Basic VElDS0VUXzA4ZWI3ZTJlMmMxNzk2NGNhNTFmMGYzMzE4NmNjMmZjOWQ1NmQ1OTM=' -d '{ "title": "My stuff", "visibility": "PUBLIC"}' 'http://localhost:8080/alfresco/api/-default-/public/alfresco/versions/1/sites' | jq % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 100 215 100 163 100 52 337 107 --:--:-- --:--:-- --:--:-* 444 { "entry": { "role": "SiteManager", "visibility": "PUBLIC", "guid": "7ef8798f-bbcd-4d92-8db5-4d51edf739f6", "id": "my-stuff", "preset": "site-dashboard", "title": "My stuff" } } ``` -------------------------------- ### Make Installer Executable on Linux Source: https://github.com/alfresco/docs-alfresco/blob/master/process-services/latest/install/manual.md Use this command to update permissions for the Linux setup wizard installer file before running it. ```bash chmod 777 ``` -------------------------------- ### Start a Process Instance Source: https://github.com/alfresco/docs-alfresco/blob/master/process-services/latest/develop/rest-api.md Use this endpoint to initiate a new process instance. Provide the process definition ID or key, and optionally a name, form values, outcome, or variables. ```bash POST api/enterprise/process-instances ``` -------------------------------- ### Verify Server Startup Source: https://github.com/alfresco/docs-alfresco/blob/master/search-enterprise/latest/install/index.md Monitor the logs for the successful startup message. ```bash alfresco_1 | 05-Sep-2021 13:36:37.893 INFO [main] org.apache.catalina.startup.Catalina.start Server startup in 148870 ms ``` -------------------------------- ### Get Process Instance Start Form Source: https://github.com/alfresco/docs-alfresco/blob/master/process-services/latest/develop/rest-api.md Retrieve the start form for a completed process instance. This is useful for inspecting form data after a process has begun. ```bash GET /enterprise/process-instances/{processInstanceId}/start-form ``` -------------------------------- ### Example Configuration File Names Source: https://github.com/alfresco/docs-alfresco/blob/master/transform-service/latest/config/index.md Demonstrates the alphanumeric sorting of pipeline configuration files. Consider using fixed-length numeric prefixes for predictable ordering. ```text localTransform.imagemagick.url=http://localhost:8091/ localTransform.libreoffice.url=http://localhost:8092/ localTransform.misc.url=http://localhost:8094/ localTransform.pdfrenderer.url=http://localhost:8090/ localTransform.tika.url=http://localhost:8093/ shared/classes/alfresco/extension/transform/pipelines/0100-basePipelines.json shared/classes/alfresco/extension/transform/pipelines/0200-a-cutdown-libreoffice.json ``` -------------------------------- ### Get Start Form Values for Field Source: https://github.com/alfresco/docs-alfresco/blob/master/process-services/latest/develop/rest-api.md Retrieves a list of possible values for a specific field within a process definition's start form. ```APIDOC ## GET /api/enterprise/process-definitions/{processDefinitionId}/start-form-values/{field} ### Description Retrieves a list of possible values for a specific field within a process definition's start form. This is useful for fields like 'typeahead'. ### Method GET ### Endpoint /api/enterprise/process-definitions/{processDefinitionId}/start-form-values/{field} ### Path Parameters - **processDefinitionId** (string) - Required - The ID of the process definition. - **field** (string) - Required - The ID of the field for which to retrieve values. ### Response #### Success Response (200) - **values** (array) - A list of available values for the specified field. The structure of each value depends on the field type. ``` -------------------------------- ### GET Process Definition Start Form Source: https://github.com/alfresco/docs-alfresco/blob/master/process-services/latest/develop/rest-api.md Retrieves the start form configuration for a process definition if it has one. This includes form field definitions and layout. ```bash GET api/enterprise/process-definitions/{process-definition-id}/start-form ``` -------------------------------- ### Combined Content and Metadata Version History Example Source: https://github.com/alfresco/docs-alfresco/blob/master/content-services/latest/admin/import-transfer.md This example demonstrates all possible combinations of content, metadata, and version files for a comprehensive version history import. ```text IMG_1967.jpg.v1 IMG_1967.jpg.metadata.properties.xml.v1 IMG_1967.jpg.v2 IMG_1967.jpg.metadata.properties.xml.v2 IMG_1967.jpg.v3 IMG_1967.jpg.metadata.properties.xml.v4 IMG_1967.jpg.metadata.properties.xml IMG_1967.jpg ``` -------------------------------- ### Initiate ZIP download process Source: https://github.com/alfresco/docs-alfresco/blob/master/content-services/latest/develop/rest-api-guide/folders-files.md Use a POST request to start the asynchronous server-side process for creating the ZIP archive. ```bash $ curl -X POST -H "Content-Type: application/json" -H 'Accept: application/json' -d '{"nodeIds":["7279b5c5-da55-4e98-8b12-72d33b90c810","1cf35d69-f85f-4446-94cd-f31ccf16c2e3"]}' -H 'Authorization: Basic VElDS0VUXzA4ZWI3ZTJlMmMxNzk2NGNhNTFmMGYzMzE4NmNjMmZjOWQ1NmQ1OTM=' http://localhost:8080/alfresco/api/-default-/public/alfresco/versions/1/downloads | jq % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 100 225 0 134 100 91 822 558 --:--:-- --:--:-- --:--:-- 1380 { "entry": { "filesAdded": 0, "bytesAdded": 0, "totalBytes": 0, "id": "3ea71d75-e2fa-4f23-9239-438c9b048574", "totalFiles": 0, "status": "PENDING" } } ``` -------------------------------- ### Get Image Renditions Source: https://github.com/alfresco/docs-alfresco/blob/master/content-services/latest/develop/reference/java-foundation-ref.md Retrieves renditions for a given node where the mimetype starts with 'image'. ```java List imageRenditions = serviceRegistry.getRenditionService().getRenditions(sourceNode, "image"); ``` -------------------------------- ### Deploy Governance Services Source: https://github.com/alfresco/docs-alfresco/blob/master/governance-services/latest/install/docker.md Commands to start the containers in the foreground or background. ```bash $ docker-compose up ``` ```bash $ docker-compose up -d ``` -------------------------------- ### Group Creation Example Source: https://github.com/alfresco/docs-alfresco/blob/master/process-services/latest/using/process/index.md Example output showing the structure of created groups. ```text Group 1 Group 2 ``` -------------------------------- ### Get Read Permissions (ACLs) with cURL Source: https://github.com/alfresco/docs-alfresco/blob/master/federation-services/latest/config/index.md Example of how to retrieve read permissions using cURL. ```bash curl -u admin:admin "localhost:8081/3sixty-admin/api/repo/**box/acls?id=77411856592 &isFolder=true**" | json_pp ``` -------------------------------- ### Start Process using RuntimeProcessInstanceService Source: https://github.com/alfresco/docs-alfresco/blob/master/process-automation/latest/model/scripts.md Initiate a process instance using the `RuntimeProcessInstanceService`. Define the process payload, including business key, process definition key, and variables. ```javascript const startProcessPayload = { businessKey: variables.businessKey, payloadType: 'StartProcessPayload', processDefinitionKey: variables.processKey, variables: { fileArray: variables.fileArray } }; const runtimeProcessInstanceService = new RuntimeProcessInstanceService(); runtimProcessInstanceService.startProcess(startProcessPayload); ``` -------------------------------- ### Retrieve children via HTTP GET Source: https://github.com/alfresco/docs-alfresco/blob/master/content-services/latest/develop/reference/cmis-ref.md Example URL for fetching children of the root/test node. ```text http://localhost:8080/alfresco/api/-default-/public/cmis/versions/1.1/browser/root/test?cmisselector=children ``` -------------------------------- ### Container Log Output Example Source: https://github.com/alfresco/docs-alfresco/blob/master/content-services/latest/develop/sdk.md Example log output from the Content Services Repository container during startup, indicating successful deployment and server startup. ```bash my-all-in-one-project-acs-1 | 11-Apr-2024 17:09:22.877 INFO [main] org.apache.catalina.startup.HostConfig.deployDirectory Deployment of web application directory [/usr/local/tomcat/webapps/_vti_bin] has finished in [116] ms my-all-in-one-project-acs-1 | 11-Apr-2024 17:09:22.883 INFO [main] org.apache.coyote.AbstractProtocol.start Starting ProtocolHandler ["http-nio-8080"] my-all-in-one-project-acs-1 | 11-Apr-2024 17:09:22.919 INFO [main] org.apache.catalina.startup.Catalina.start Server startup in [39015] milliseconds ``` -------------------------------- ### Build and Start Alfresco Server Source: https://github.com/alfresco/docs-alfresco/blob/master/content-services/latest/tutorial/share/amd.md Execute this command in the terminal to build the project and start the Alfresco server. This step is necessary to deploy the changes made to the extension module. ```bash ./run.sh build_start ``` -------------------------------- ### Async Picklist Query Example Source: https://github.com/alfresco/docs-alfresco/blob/master/content-accelerator/latest/configure/other-aca-admin-configs.md Use the '$query$' token to filter server-side results for async picklists based on user input. This example filters for vendor names starting with the typed characters. ```xml ```