### Run AEM Quickstart with Verbose Option Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/sites-deploying/troubleshooting.md Use the -v option when starting the AEM Quickstart JAR to display log output on the console for troubleshooting purposes. ```bash java -jar cq-wcm-quickstart-<version>.jar -v ``` -------------------------------- ### AEM Quickstart JAR File Structure Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/sites-deploying/deploy.md This structure represents the essential files to be placed in the AEM installation directory. It includes the quickstart JAR and the license properties file required for startup. ```shell / cq-quickstart-6.5.0.jar license.properties ``` -------------------------------- ### css.txt Example for Client Library Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/sites-developing/widgets.md Lists CSS files to be aggregated by the CQ client library service. Ensure the file starts with '#base=css'. ```text #base=css components.css ``` -------------------------------- ### js.txt Example for Client Library Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/sites-developing/widgets.md Lists JavaScript files to be aggregated by the CQ client library service. Ensure the file starts with '#base=js'. ```text #base=js components.js exercises.js CustomWidget.js CustomBrowseField.js InsertTextPlugin.js ``` -------------------------------- ### Start AEM with MongoDB Storage Backend Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/sites-deploying/storage-elements-in-aem-6.md Run the AEM quickstart jar with the '-r crx3,crx3mongo' argument to enable MongoDB storage support. ```shell java -jar cq-quickstart-6.jar -r crx3,crx3mongo ``` -------------------------------- ### Start SolrCloud Mode Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/communities/demo-mongo.md Starts Solr in SolrCloud mode with ZooKeeper embedded. This command is for a basic, non-production setup and requires Solr to be installed. ```bash java -Dbootstrap_confdir=./solr/collection1/conf -Dbootstrap_conf=true -DzkRun -jar start.jar ``` -------------------------------- ### View Quickstart Options Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/sites-developing/contributing-to-cq.md Run the AEM Quickstart JAR with the -help flag to view available startup options, such as port number and instance type. ```shell java -jar .jar -help ``` -------------------------------- ### Create an Experience Manager Server Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/assets/use-assets-across-connected-assets-instances.md Use this command to create an Experience Manager server instance. Ensure you replace `` with the actual path to your JAR file. ```bash java -Xmx4096m -jar -r samplecontent -p 4502 -nofork -gui -nointeractive & ``` -------------------------------- ### PhoneGap CLI Installation Output Example Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/mobile/building-app-mobile-phonegap.md This is an example of the terminal output after a successful PhoneGap CLI installation, showing the installed paths and dependencies. ```xml /usr/local/bin/phonegap -> /usr/local/lib/node_modules/phonegap/bin/phonegap.js phonegap@3.3.0-0.19.6 /usr/local/lib/node_modules/phonegap ├── pluralize@0.0.4 ├── colors@0.6.0-1 ├── semver@1.1.0 ├── qrcode-terminal@0.9.4 ├── shelljs@0.1.4 ├── optimist@0.6.0 (...) ├── prompt@0.2.11 (...) ├── phonegap-build@0.8.4 (...) ├── connect-phonegap@0.8.1 (...) └── cordova@3.3.0-0.1.1 (...) ``` -------------------------------- ### Display AEM Quickstart Help Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/sites-deploying/custom-standalone-install.md Use the -help option to view all available command-line arguments for the AEM Quickstart JAR. This is useful for understanding configuration possibilities. ```shell java -jar cq-quickstart-6.5.0.jar -help ``` -------------------------------- ### Start CRX with Verbose Option Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/sites-administering/troubleshooting.md Start CRX with the -v (verbose) option to display some of the quickstart log output directly on the console for troubleshooting. ```bash java -jar crx-<*version*>-<*edition*>.jar -v ``` -------------------------------- ### Configure Publish Instance Port Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/sites-deploying/deploy.md Rename the quickstart JAR file to specify the instance type and port number. This example configures a publish instance to run on port 4503. ```shell cq-publish-p4503.jar ``` -------------------------------- ### Launch AEM from Command Line Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/sites-deploying/deploy.md Use this command to start an AEM instance from the command line, specifying the maximum heap size. Ensure you are in the directory containing the quickstart JAR. ```shell java -Xmx1024M -jar cq-quickstart-6.5.0.jar ``` -------------------------------- ### Unpack AEM Quickstart JAR Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/sites-administering/mitigating-serialization-issues.md Use this command to unpack the AEM quickstart JAR file, which is necessary for extracting the NotSoSerial agent when installing on application servers. ```shell java -jar aem-quickstart-6.2.0.jar -unpack ``` -------------------------------- ### SRT Configuration File Example Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/forms/using/install-configure-document-services.md Configure options for the System Readiness Tool using the `srt_config.yaml` file. This example shows the format for setting locale, temporary directories, user permissions, and output directories. ```yaml # ================================================================= # SRT Configuration # ================================================================= #Note - follow correct format to avoid parsing failures #for example, : #locale: (mandatory field)Locale to be used for SRT. Supported locales [en/fr/de/ja]. locale: en #aemTempDir: AEM Temp direcotry aemTempDir: #users: provide PDFG converting users list #users: # - user1 # - user2 users: #profile: select profile to run specific checks. Choose from [LCM], more will be added soon profile: #outputDir: directory where output files will be saved outputDir: ``` -------------------------------- ### Start Solr in Standalone Mode Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/communities/demo-mongo.md Starts a Solr HTTP server in standalone mode using the example configuration. This is suitable for testing and demonstration purposes. The default port is 8983. ```bash cd /example java -jar start.jar ``` -------------------------------- ### Paginated Query Example Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/sites-developing/headless/graphql-api/graphql-api-content-fragments.md This example demonstrates how to perform a paginated query for adventure content fragments using the 'first' and 'after' arguments. It retrieves up to five adventures starting from a specific cursor. ```APIDOC ## Paginated Query - first and after The `...Paginated` query type reuses most of the `...List` query type features (filtering, sorting), but instead of using `offset`/`limit` arguments, it uses the `first`/`after` arguments as defined by [the GraphQL Cursor Connections Specification](https://relay.dev/graphql/connections.htm). * `first`: The `n` first items to return. The default is `50`. The maximum is `100`. * `after`: The cursor that determines the beginning of the requested page. The item represented by the cursor is not included in the result set. The cursor of an item is determined by the `cursor` field of the `edges` structure. For example, output the page of results containing up to five adventures, starting from the given cursor item in the *complete* results list: ```graphql query { adventurePaginated(first: 5, after: "ODg1MmMyMmEtZTAzMy00MTNjLThiMzMtZGQyMzY5ZTNjN2M1") { edges { cursor node { title } } pageInfo { endCursor hasNextPage } } } ``` ``` -------------------------------- ### AEM Quickstart Command-Line Options Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/sites-deploying/custom-standalone-install.md This section lists common command-line options for customizing the AEM Quickstart server startup. Options include setting the port, context path, enabling debugging, and controlling browser behavior. ```shell Usage: Use these options on the Quickstart command line. -------------------------------------------------------------------------------- -help (--help,-h) Show this help message -quickstart.server.port (-p,-port) Set server port number -contextpath (-c,-org.apache.felix.http.context_path) Set context path -debug Enable Java Debugging on port number; forces forking -gui Show GUI if running on a terminal -nobrowser (-quickstart.nobrowser) Do not open browser at startup -unpack Unpack installation files only, do not start the server (implies -verbose) -v (-verbose) Do not redirect stdout/stderr to files and do not close stdin -nofork Do not fork the JVM, even if not running on a console -fork Force forking the JVM if running on a console, using recommended default memory settings for the forked JVM. -forkargs [ ...] Additional arguments for the forked JVM, defaults to '-Xmx1024m -XX:MaxPermSize=256m '. Use -- to specify values starting with -, example: '-forkargs -- -server' -a (--interface) Optional IP address (interface) to bind to -pt Process type (main/fork) - do not use directly, used when forking a process -r [ [ [ [ [ [ [ [ []]]]]]]]] Runmode(s) - Use this to define the run mode(s) -b Base folder - defines the path under which the quickstart work folder is created -low-mem-action Low memory action - what to do if memory is insufficient at startup -use-control-port Start a control port -nointeractive Start with no interactivity -ll Define launchpad log level (1 = error...4 = debug) -n Do not install shutdown hook -D= Additional framework properties. -listener-port Set listener port number -x Run a Quickstart extension. Options for executing Quickstart extensions: -xargs [ ...] Construct an arguments list for a Quickstart extension (for example, -xargs -- -arg1 val1 -arg2 val2). -------------------------------------------------------------------------------- ``` -------------------------------- ### Configure Author Instance Port Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/sites-deploying/deploy.md Rename the quickstart JAR file to specify the instance type and port number. This example configures an author instance to run on port 4502. ```shell cq-author-p4502.jar ``` -------------------------------- ### Start MongoDB Server Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/communities/demo-mongo.md Starts a MongoDB server instance using the specified data directory. Ensure MongoDB is installed and the data path is defined. This command uses the default port 27017. ```bash /bin/mongod --dbpath ``` -------------------------------- ### init(name, config) Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/sites-developing/contexthub-api.md Initializes a ContextHub store with a given name and configuration. ```APIDOC ## init(name, config) ### Description Initializes the store. * Sets the store data to an empty object. * Sets the store references to an empty object. * The eventChannel is data:*name*, where *name* is the store name. * The storeDataKey is /store/*name*, where *name* is the store name. ### Parameters #### Path Parameters * **name** (String) - Required - The name of the store. * **config** (Object) - Required - An object that contains configuration properties: * eventDeferring (Number) - Default value is 32. * eventing (ContextHub.Utils.Eventing) - The [ContextHub.Utils.Eventing](/help/sites-developing/contexthub-api.md#contexthub-utils-eventing) object for this store. The default value is the ContextHub.eventing object uses. * persistence (ContextHub.Utils.Persistence) - The ContextHub.Utils.Persistence object for this store. The default value is the ContextHub.persistence object. ``` -------------------------------- ### Start Standby Instance with Standby Run Mode Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/sites-deploying/tarmk-cold-standby.md Start the AEM quickstart JAR with the 'standby' run mode enabled, along with 'crx3' and 'crx3tar'. This command initiates the AEM instance in standby mode. ```bash java -jar quickstart.jar -r standby,crx3,crx3tar ``` -------------------------------- ### Handle Quickview Activation Event Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/assets/interactive-videos.md This example demonstrates how to set up an event handler for the 'quickViewActivate' event emitted by the interactive video viewer. It extracts the SKU from the event data and calls a placeholder function 'loadQuickView' to initiate the Quickview process. ```javascript /* // Example of interactive video event for quickview. s7interactivevideoviewer.setHandlers({ "quickViewActivate": function(inData) { var sku=inData.sku; //SKU for product ID //To pass other parameter from the hotspot, you need to add custom parameter during the hotspot setup as parameterName=value loadQuickView(sku); //Replace this call with your quickview plugin //See your quickviewer plugin for the quickview call }, "initComplete":function() { //--- Attach quickview popup to viewer container so popup will work in fullscreen mode --- var popup = document.getElementById('quickview_div'); // get custom quickview container popup.parentNode.removeChild(popup); // remove it from current DOM var sdkContainerId = s7interactivevideoviewer.getComponent("container").getInnerContainerId(); // get viewer container component var inner_container = document.getElementById(sdkContainerId); ``` -------------------------------- ### Start Webpack Development Server Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/commerce/cif/customizing/style-cif-component.md Navigate to the ui.frontend directory and run 'npm start' to launch the webpack-dev-server for local front-end development. ```shell $ cd ui.frontend $ npm start ``` -------------------------------- ### Getting and Setting Tags Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/sites-developing/building.md Provides code examples for retrieving the tags associated with a resource and for setting tags on a resource. ```APIDOC ## Getting and Setting Tags ```java // Getting the tags of a Resource: Tag[] tags = tagManager.getTags(resource); // Setting tags to a Resource: tagManager.setTags(resource, tags); ``` ``` -------------------------------- ### Paging Example Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/journey-headless/developer/update-your-content.md Demonstrates how to use offset and limit parameters for paginated GET requests to the Assets REST API. ```APIDOC ## Paging The Assets REST API supports paging (for GET requests) via the URL parameters: * `offset` - the number of the first (child) entity to retrieve * `limit` - the maximum number of entities returned The response will contain paging information as part of the `properties` section of the SIREN output. This `srn:paging` property contains the total number of (child) entities ( `total`), the offset and the limit ( `offset`, `limit`) as specified in the request. >[!NOTE] > Paging is typically applied on container entities (that is, folders or assets with renditions), as it relates to the children of the requested entity. #### Example: Paging `GET /api/assets.json?offset=2&limit=3` ```json { "properties": { "srn:paging": { "total": 7, "offset": 2, "limit": 3 } } } ``` ``` -------------------------------- ### Set Quickview Activate Handler with SKU in URL Path Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/assets/interactive-videos.md This example demonstrates constructing a Quickview URL where the single SKU is found in the URL path. ```javascript s7interactivevideoviewer.setHandlers({ "quickViewActivate": function(inData) { var quickViewUrl = "https://server/product/" + inData.sku; }, }); ``` -------------------------------- ### AEM Bundle Status Log Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/sites-developing/extending-msm.md This is an example of the AEM error.log output indicating that a custom bundle has been successfully started and registered as a service. ```log 13.08.2013 14:34:55.450 *INFO* [OsgiInstallerImpl] com.adobe.example.msm.MyLiveActionFactory-bundle BundleEvent RESOLVED 13.08.2013 14:34:55.451 *INFO* [OsgiInstallerImpl] com.adobe.example.msm.MyLiveActionFactory-bundle BundleEvent STARTING 13.08.2013 14:34:55.451 *INFO* [OsgiInstallerImpl] com.adobe.example.msm.MyLiveActionFactory-bundle BundleEvent STARTED 13.08.2013 14:34:55.453 *INFO* [OsgiInstallerImpl] com.adobe.example.msm.MyLiveActionFactory-bundle Service [com.adobe.example.msm.ExampleLiveActionFactory,2188] ServiceEvent REGISTERED 13.08.2013 14:34:55.454 *INFO* [OsgiInstallerImpl] org.apache.sling.audit.osgi.installer Started bundle com.adobe.example.msm.MyLiveActionFactory-bundle [316] ``` -------------------------------- ### Get Keys from ContextHub Store Source: https://github.com/adobedocs/experience-manager-65.en/blob/main/help/sites-developing/contexthub-api.md Retrieves an array of key names from the store. Optionally include internal keys starting with an underscore. ```javascript getKeys(includeInternals) ```