Building Sites with Oracle Content Management

Oracle® Cloud Building Sites with Oracle Content Management

F24096-23 September 2021 Oracle Cloud Building Sites with Oracle Content Management,

F24096-23

Primary Author: Bruce Silver

Contributing Authors: Jean Wilson, Sarah Bernau, Kalpana N, Ron van de Crommert

Contributors: Bonnie Vaughan

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract. The terms governing the U.S. Government’s use of Oracle cloud services are defined by the applicable contract for such services. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle, Java, and MySQL are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle. Contents

Preface Audience xvi Documentation Accessibility xvi Diversity and Inclusion xvi Related Resources xvi Conventions xvii

Part I Introduction

1 Overview of Oracle Content Management Access Oracle Content Management 1-1 Understand Roles 1-2 Manage Assets 1-2 Manage Content 1-2 Collaborate on Content 1-3 Build Sites 1-3 Integrate and Extend Oracle Content Management 1-3 Get Started 1-4 Migrate to Oracle Cloud Infrastructure 1-4

2 Get Started with Building Sites Get Started with Sites 2-1 Understand the Site Creation Process 2-2 Learn About Site Development 2-3 Understand Site Governance 2-5

3 Create Your First Website Before You Begin 3-1 Step 1: Set Up the Environment 3-2

iii Import the Minimal-NavMenu Custom Component 3-2 Publish the Minimal-NavMenu Custom Component 3-3 Add Sample Images 3-4 Step 2: Set Up the Website 3-6 Create the Website 3-6 Edit the Website 3-7 Step 3: Publish the Website 3-27 Do More 3-30

Part II Creating and Editing Sites

4 Create Sites Create Sites 4-1 Copy Sites 4-3 Manage Site Requests 4-5 Change Site Request Details 4-6 View Site Request Policies 4-6

5 Edit Sites Get to Know the Site Builder Page 5-1 Understand Site Updates 5-3 Use an Update 5-5 Editing Tips and Tricks 5-5 Use Styles and Formatting 5-10 Customize Site Settings 5-10 Add Custom Site Properties 5-12 Work with Tables 5-13 Upload Site Files 5-15

6 Use Templates and Themes in Sites Understand Templates 6-1 Create a Template from a Site 6-4 Change Template Details 6-5 Change Template Policies 6-6 Change Template Status or Audience 6-7 Manage Templates 6-8 Export and Import Templates 6-11 Understand Themes 6-12

iv Manage Themes 6-14 Publish Themes 6-16

7 Manage Custom Components and Layouts Understand Custom Components 7-1 Understand Layouts 7-2 Use Custom Components and Layouts 7-4 Register Remote Components 7-7 Create Local Components, Layouts, Content Field Editors, or Content Forms 7-8 Export or Import Components or Layouts 7-10

8 Work with Site Pages Navigate to a Page 8-1 View Pages 8-1 Add Pages 8-3 Move Pages 8-6 Delete Pages 8-6 Change Page Settings 8-7 Change the Page Layout 8-10 Change the Background or Theme 8-11

9 Arrange Page Content Add Components and Section Layouts 9-1 Work with Assets and Content Items 9-3 Use Triggers and Actions 9-4 Use Horizontal Section Layouts 9-5 Use Two and Three Column Layouts 9-6 Use Vertical Section Layouts 9-8 Use Tabbed Section Layouts 9-9 Use Slider Section Layouts 9-9

10 Use Built-In Components Basic Components 10-2 Titles 10-2 Paragraphs 10-4 Plain Text 10-6 Buttons 10-6 Structure Components 10-8

v Dividers 10-9 Spacers 10-9 Media Components 10-10 Images 10-10 Galleries 10-12 Gallery Grid 10-15 YouTube Videos 10-19 Videos 10-19 Document Components 10-21 Documents 10-21 Folder Lists 10-22 File Lists 10-23 Documents Manager 10-25 Project Library 10-26 Social Components 10-28 Social Bar 10-28 Facebook Like and Recommend 10-29 Twitter Share and Follow 10-30 Conversation Component 10-30 Conversation List 10-33 Process Components 10-34 Process Start Form 10-34 Process Task List 10-36 Task Detail Form 10-38 Content Items 10-39 Content Item Component 10-40 Content Placeholder 10-41 Content List 10-42 Content Search 10-47 Recommendation 10-48 Other Components 10-49 Maps 10-50 Headlines 10-51 Articles 10-52 Images with Text 10-54 Component Groups 10-55 Using Cobrowse on a Page 10-56 Oracle Intelligent Advisor 10-58 Oracle Visual Builder 10-58

vi Part III Publishing and Managing Sites

11 Manage Sites Get to Know the Sites Page 11-1 Manage Sites and Site Settings 11-2 Change the Site Description, Logo, or Embed Properties 11-6 Set Search Engine Properties 11-7 Enable Prerender Service for Search Engine Optimization 11-8 Set Static Site Delivery Options 11-10 Enable Automatic Compilation on Publish 11-10 Override Default Cache Control Headers for Compiled Sites 11-11 Specify Mobile User-Agents to Support Compiled Adaptive Layouts 11-11 Specify and Configure Vanity URLs 11-12 Enable Cobrowse Integration 11-14 Add Analytics Tracking 11-15

12 Publish Sites Bring a Site Online or Take It Offline 12-1 Publish Site Changes 12-2

13 Secure Sites Understand Site Security 13-1 Change Site Security 13-3

14 Work with Multilingual Sites Overview of Multilingual Sites 14-1 Translate a Site 14-2 Manage Site Translation Jobs 14-4 Locales for Translation 14-5 Custom Locales for Translation 14-5 Set Locale Alias for URL Redirect 14-5

15 Use Site Redirects or URL Mapping Plan for Redirects 15-1 Simple String-to-String Matching 15-1 Simplified Wildcard Matching 15-2

vii Add Site Redirects 15-2 Specify Redirect Rules in a JSON File 15-3 Upload a Redirect Rules File to a Site 15-9 Map a Site URL 15-9

16 Improve Site Performance Leverage Caching to Improve Performance 16-1 Runtime Caching 16-2 Site Builder Caching 16-3 Above the Fold (ATF) Rendering 16-3

Part IV Developing for Sites

17 Customize Designs and Styles About Designs 17-1 Design Files 17-1 Responsive Table Design 17-4 Customize Conversation List Styles 17-7 Customize Folder List and File List Styles 17-9 Customize Social Bar Icons 17-11 Configure Interview Styling Extensions for Oracle Intelligent Advisor 17-12

18 Understand Background Use About Background and Themes 18-1 How Backgrounds Are Implemented 18-1 Where Settings Are Stored 18-2

19 Set Triggers and Actions About Triggers and Actions 19-1 Set Triggers 19-1 Set Actions 19-3

20 Develop Templates About Templates 20-1 Basic Template Structure 20-2 Create a Template 20-4

viii Export a Template 20-5 Import a Template 20-6 Work with a Starter Template 20-6 Create a Site Template from Bootstrap or a Website Design Template 20-10 Develop Templates with Developer Cloud Service 20-15 Sign in to the Developer Cloud Service Console for Oracle Content Management 20-16 Create a Project in Developer Cloud Service 20-17 Create Templates in Developer Cloud Service 20-17 Copy a Template in Developer Cloud Service 20-18 Import a Template into Developer Cloud Service 20-18 Merge Changes 20-18 Export a Template from Developer Cloud Service 20-19

21 Develop Themes About Themes 21-1 Basic Theme Structure 21-3 Site Navigation 21-4 Create a Theme 21-7 Hide Components and Section Layouts for a Theme 21-12 Hide Component Alignment, Width or Spacing Options for a Theme 21-13 Associate Components with Themes 21-15 Sites Rendering API 21-17

22 Develop Layouts About Layouts 22-1 Search Engine Optimization (SEO) 22-3 Understand the components.json File and Format 22-5 Customize Toolbar Groups in Site Builder 22-8 Restrict Components in Slots 22-12 Make Layout Content Editable 22-14 Create a Section Layout 22-15 Create a Section Layout That Supports Lazy Load 22-17 Develop Custom Section Layouts with APIs 22-17 Develop Content Layouts 22-22 Create Content Layouts with Oracle Content Management 22-24 Pass a Layout View to a Content Layout 22-30 Generate a Site Details Page URL with an API 22-30 Develop Content Layouts Locally with Developer Cloud Service 22-31 Create a Content Layout with Developer Cloud Service 22-32

ix Define the RequireJS Module 22-33 Configure the Constructor Function Parameter 22-34 Render the Content Layout 22-35 Edit the Content Layout in the Mustache Template 22-35 Add Dynamic DOM Manipulation 22-35 Define Styles in the design.css File 22-36 Get Reference Items 22-36 Get a Media URL 22-36 Raise Triggers 22-36 Navigate to a Search Page with a Search Query 22-37 Expand Macros and Render Rich Text 22-38 Link to the Details Page 22-38 Expand Macros in Content List Queries 22-38 Develop Robust Content Layouts 22-42 Render Content Items 22-42 Standardize the Structure of Data for a Content Layout 22-43 Create the Sample Blog Template 22-47 Add Content Layout Mappings to Templates 22-48 Test Content Layouts with the Local Test Harness 22-48 Test with a Local Test Harness 22-48 Import Templates with Content Layouts into Oracle Content Management 22-49

23 Develop Components About Components 23-1 About Developing Components 23-2 Create a Component 23-5 Develop Custom Components with Developer Cloud Service 23-6 Develop a Custom Component for Oracle Content Management 23-7 Develop Your Custom Component 23-7 Write and Run Unit Tests 23-9 Optimize Components (Minify) for Better Performance 23-10 Run Continuous Integration Jobs 23-10 Develop Translatable Components for Multilingual Sites 23-11 Build an H1 Component with a Settings Panel 23-11 Create a New Local Component 23-12 Build the Basic H1 Component 23-12 Add CSS for Your Component 23-16 Add a Settings Panel to Change Heading Text 23-17 Update the Theme for Others to Pick the H1 Component Style 23-18 Create a Simple Component Using HTML Templates 23-20

x Create the HTML Component 23-20 Add User-Supplied Data to the HTML Component 23-24 Compare Local Components to Remote Components 23-28 Render Component Settings 23-29 Local Component Implementation 23-30 Style Classes for Components 23-31 How to Style Built-In Components 23-33 Component Styling Basics 23-33 Component-Specific Styling 23-35 Set Component Properties 23-42 Components Rendered in Inline Frames 23-43 About the Instance ID and Structure for Components Rendered in Inline Frames 23-45 Security for Remote Components 23-46 Register a Remote Component 23-48 Delete a Component 23-48 Sites SDK 23-49

24 Customize the Controller File About the Controller File 24-1 Default Controller File 24-1 Modify the Default controller.html File 24-2 About the SCS Object 24-3 SCS.sitePrefix 24-3 SCS.preInitRendering 24-3 SCS.getDeviceInfo 24-4 Controller File Sections That Should Not Be Customized 24-4 Use Tokens to Allow Custom Controller File Portability 24-5 Custom Controller File Samples 24-6 Changing the Site Prefix 24-6 Customizing the Wait Graphic 24-7 Customizing Favicons 24-9 Customizing

Modify the Default controller.html File

Download a site's controller.html file and modify it to affect the behavior of each site page. To download a site's controller.html file: 1. Open the site you want to modify in Site Builder and set it to Edit. 2. Select an existing update or create a new one. 3. Click Settings in the side navigation menu and then Site.

4. In the Controller File section, click Download default controller file. 5. Save to your local drive and customize the controller.html file with your edits. 6. When done editing, return to the settings page of the site and in the Controller File section, click Select file to upload.

24-2 Chapter 24 About the SCS Object

7. Navigate to the modified controller file and upload it.

Note:

Customizations to the controller file are only used in online sites. They will not be used when editing a site or in site previews. For the changes to take effect after uploading a custom controller.html file for a site, the site update must be committed and the site must be published.

About the SCS Object

The controller JavaScript uses variables and properties defined in the global SCS object in order to render the web page. The global JavaScript object must be defined in the controller file before the inclusion of the controller.js file. There are two primary properties in the SCS object that can be used for customization: • SCS.sitePrefix • SCS.preInitRendering • SCS.getDeviceInfo SCS.sitePrefix

The SCS.sitePrefix variable defines the path prefix of the online site. Normally this defaults to site//. The controller JavaScript uses this value to determine what web page to display. For example, if the browser is requesting the page at /site/SampleSite/products/index.html, the sitePrefix /site/SampleSite/ allows the JavaScript to compute that the products/ index.html page in the site should be displayed. Note that the sitePrefix must be a string value that begins and ends with a "/" character. If a proxy or other infrastructure such as Akamai and URL mapping rules are in place, modifying this variable allows the site prefix to be customized. For example, setting the sitePrefix to /intranet/ExampleSite/ would allow the web site to be delivered with that pathname in the browser instead of the default /site/SampleSite/ path prefix.

Note:

Internally the default controller JavaScript uses "/" as the sitePrefix if the URL in the browser does not match the site prefix. This allows the site to be served using a vanity domain without customization.

SCS.preInitRendering

If defined, the SCS.preInitRendering function is called by the controller JavaScript code before any of its computational logic executes. This is a useful function to define in custom controller files to override basic operations of the controller JavaScript.

24-3 Chapter 24 Controller File Sections That Should Not Be Customized

If defined, SCS.preInitRendering must be a function. It is called without any arguments, and no return value is expected or processed. SCS.getDeviceInfo

The SCS.getDeviceInfo function allows customization of the device detection logic inside the controller JavaScript. This detection is used to determine if a mobile or responsive version of a page should be delivered.

The SCS.getDeviceInfo function does not take any arguments, and it returns a JavaScript Object having two properties: • isMobile—a Boolean property indicating that the current device is a mobile client, like a smart phone. • isIOS—a Boolean property indicating that the current device is running on an iOS- based operating system. If the custom controller does not override SCS.getDeviceInfo, the built-in default implementation is used. Controller File Sections That Should Not Be Customized

Certain sections of the controller file are processed by the Oracle Content Management server in order to use the CDN and to define URL caching segments. These are noted inline in the sample below.

24-9 Chapter 24 Custom Controller File Samples

24-12 Part V Developing for Sites with Other Tools

Oracle Content Management provides several ways to interact with applications and experiences developed either inside Oracle Content Management or outside of Oracle Content Management using other 3rd party tools.

Using Oracle Content Management Toolkit The Oracle Content Management Toolkit and SDKs help you develop custom applications that consume content that is managed in the Oracle Content Management repository. These applications can be developed in Oracle Content Management or using 3rd party tools. Content Toolkit can help you do the following tasks: • Set up your local development environment to use an Oracle Content Management instance for local development and testing of components, templates, themes, and content layouts • Create components, site templates, and content layouts from samples, run them in the test harness, explore them, and develop the components, templates, themes, and content layouts in a Developer Cloud Service environment • Import components and site templates that were created in Oracle Content Management into a Developer Cloud Service project and environment for source management and further development • Export components, templates, and content layouts from a Developer Cloud Service environment for use in Oracle Content Management • Copy an existing component, template, or content layout • Write unit tests • Optimize components • Deploy your components and templates to Oracle Content Management Additional information can be found at https://github.com/oracle/content-and-experience- toolkit#readme.

Experience Orchestration If you use tools other than Oracle Content Management to create experiences, you can connect Oracle Content Management repositories to these experiences so content creators can preview site changes as they work and automatic builds can be triggered when content changes or is published. This experience orchestration automates the workflow process between content providers and site developers to simplify experience management and publication. 25 Develop with Oracle Content Management Toolkit

Oracle Content Management Toolkit helps you develop site templates, themes, custom components, and content layouts for Oracle Content Management. With Content Toolkit, you work in your own development environment and can use asset repositories, files, and folders in Oracle Content Management. Content Toolkit has tools to create and develop custom components and site templates, including themes and content layouts. It includes a local test harness for quick, iterative development and sample unit tests to start with. The following topics describe how to set up Content Toolkit and develop with it on your local machine or as a Developer Cloud Service project: • Set Up Oracle Content Management Toolkit on Your Local Machine • Upgrade to jQuery 3.5.x • Develop for Oracle Content Management with Developer Cloud Service • Propagate Changes from Test to Production with Oracle Content Management Toolkit • Create a Site from a Template and Keep the Same GUIDs for Content • Import and Export Taxonomies • Import and Export Recommendations • Develop Custom Field Editors Using the Oracle Content Management Toolkit • Transfer or Update a Site from One Server to Another • Index Site Pages with Oracle Content Management Toolkit • Index a Multilingual Site with Oracle Content Management Toolkit • Create a Simplified Component for Easy Component Development • Compile a Site to Improve Runtime Performance for Site Pages • Create a New Site or Asset Translation Job in the Oracle Content Management Server • Translate a Site with a Language Service Provider Set Up Oracle Content Management Toolkit on Your Local Machine

On your local machine, you can download Content Toolkit from GitHub. To set up Content Toolkit, follow the instructions at

https://github.com/oracle/content-and-experience-toolkit/blob/master/ README.md

25-1 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine

Complete the setup and prepare to use Content Toolkit:

1. Install Dependencies Through npm 2. Use the cec Command-Line Utility 3. Test with a Local Test Harness Install Dependencies Through npm

Use npm (node package manager) to install sites dependencies for your project.

If you are using a proxy to access the Internet, set the proxy for npm with the npm config command. See https://docs.npmjs.com/misc/config. To set the proxy for bower, see https://bower.io/docs/config/.

Note:

Ensure that you have Node.js 8.0.0 or later (https://nodejs.org/) installed on your local computer.

Use the cec Command-Line Utility

The cec cross-platform command-line utility provides commands for creating and managing templates and components.

Before you use the cec command-line utility, create source in your local development environment for commands that require a connection to the Oracle Content Management server. Integrated help provides information to run the commands, with examples. To view the cec integrated help, you can type cec commands in the command line:

• In a terminal window, go to the cec directory. • Type cec to list the cec commands.

cec ------Usage: cec [options]

Run cec -h' to get the detailed help for the command.

Commands:

Documents cec create-folder Creates a folder or folder hierarchy on OCM server. [alias: cfd] cec share-folder Shares folder with users and groups on OCM server. [alias: sfd] cec unshare-folder Deletes user or group access to a shared folder on OCM server. [alias: usfd] cec list-folder Displays folder hierarchy on OCM server. [alias: lfd] cec download-folder Downloads folder

25-2 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine from OCM server. [alias: dlfd] cec upload-folder Uploads folder to OCM server. [alias: ulfd] cec delete-folder Deletes folder on OCM server. [alias: ] cec download-file Downloads file from OCM server. [alias: dlf] cec upload-file Uploads file to OCM server. [alias: ulf] cec delete-file Deletes file on OCM server. [alias: ]

Components cec create-component Creates the component . [alias: cc] cec copy-component [] Copies an existing component named to . [alias: cpc] cec import-component Imports a component from . [alias: ic] cec export-component Exports the component as a zip file. [alias: ec] cec download-component Downloads the components from the OCM server. [alias: dlcp] cec upload-component Uploads the components to the OCM server. [alias: ulcp] cec control-component Performs action on components on OCM server. [alias: ctcp] cec share-component Shares component with users and groups on OCM server. [alias: sc] cec unshare-component Deletes user or group access to a component on OCM server. [alias: usc]

Templates cec create-template Creates the template . [alias: ct] cec create-template-from-site Creates the template from site on the OCM server. [alias: ctfs] cec download-template Downloads the template from the OCM server. [alias: dlt] cec compile-template Compiles the site within the template. [alias: cmpt] cec copy-template [] Copies an existing template named to . [alias: cpt] cec import-template Imports a template from . [alias: it] cec export-template Exports the template as a zip file. [alias: et] cec upload-template Uploads the template to the OCM server. [alias: ult] cec delete-template Deletes the template on the OCM server. [alias: ] cec share-template Shares template with users and groups on OCM server. [alias: stm] cec unshare-template Deletes user or group access to a template on OCM server. [alias: ustm]

25-3 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine

cec update-template Performs action on a local template. [alias: ut] cec describe-template Describes the template package. [alias: dst] cec create-template-report Generates an asset usage report for the template package. [alias: cttr]

Themes cec add-component-to-theme Adds a component to a theme. [alias: actt] cec remove-component-from-theme Removes a component from a theme. [alias: rcft] cec control-theme Performs action on theme on OCM server. [alias: ctt] cec share-theme Shares theme with users and groups on OCM server. [alias: sth] cec unshare-theme Deletes user or group access to a theme on OCM server. [alias: usth]

Sites cec create-site Creates Enterprise Site . [alias: cs] cec copy-site Copies Enterprise Site . [alias: cps] cec update-site Update Enterprise Site . [alias: us] cec transfer-site Transfers a site from one OCM server to another. [alias: ts] cec transfer-site-content Creates scripts to transfer site content from one OCM server to another. [alias: tsc] cec validate-site Validates site . [alias: vs] cec control-site Performs action on site on OCM server. [alias: cts] cec share-site Shares site with users and groups on OCM server. [alias: ss] cec unshare-site Deletes user or group access to a site on OCM server. [alias: uss] cec delete-site Deletes site on the OCM server. [alias: ] cec get-site-security Gets site security on OCM server. [alias: gss] cec set-site-security Sets site security on OCM server. [alias: sss] cec index-site Index the page content of site on OCM server. [alias: is] cec create-site-map Creates a site map for site on OCM server. [alias: csm] cec create-rss-feed Creates RSS feed for site on OCM server. [alias: crf] cec create-asset-report Generates an asset usage report for site on OCM server. [alias: car] cec upload-static-site-files Uploads files to

25-4 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine render statically from a site on OCM server. [alias: ulss] cec download-static-site-files Downloads the static files from a site on OCM server. [alias: dlss] cec delete-static-site-files Deletes the static files from a site on OCM server. [alias: ] cec refresh-prerender-cache Refreshes pre-render cache for a site on OCM server. [alias: rpc] cec migrate-site Migrates a site from OCI IC server to EC server. [alias: ms]

Assets cec download-content Downloads content from OCM server. [alias: dlc] cec upload-content Uploads local content to a repository on OCM server. [alias: ulc] cec control-content Performs action on channel items on OCM server. [alias: ctct] cec transfer-content Creates scripts to transfer content from one OCM server to another. [alias: tc] cec list-assets Lists assets on OCM server. [alias: la] cec create-digital-asset Creates digital asset [alias: cda] cec update-digital-asset Updates digital asset [alias: uda] cec copy-assets Copies assets to another repository on OCM server. [alias: ca] cec create-asset-usage-report Generates an asset usage report for assets on OCM server. [alias: caur]

Content cec create-repository Creates a repository on OCM server. [alias: cr] cec control-repository Performs action on repositories on OCM server. [alias: ctr] cec share-repository Shares repository with users and groups on OCM server. [alias: sr] cec unshare-repository Deletes user or group access to a repository on OCM server. [alias: usr] cec set-editorial-permission Grants repository members Editorial Permissions on assets. [alias: sep] cec list-editorial-permission Lists repository members Editorial Permissions on assets. [alias: lep] cec create-collection Creates a collection on OCM server. [alias: ccol] cec control-collection Performs action on collections on OCM server. [alias: ctcl] cec create-channel Creates a channel on OCM server. [alias: cch] cec share-channel Shares channel with users and groups on OCM server. [alias: sch] cec unshare-channel Deletes user or group access to a channel on OCM server. [alias: usch] cec create-localization-policy Creates a localization policy on OCM server. [alias: clp]

25-5 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine

cec list-server-content-types Lists all content types from server. [alias: lsct] cec share-type Shares type with users and groups on OCM server. [alias: st] cec unshare-type Deletes user or group access to a type on OCM server. [alias: ust] cec download-type Downloads types from OCM server. [alias: dltp] cec upload-type Uploads types to OCM server. [alias: ultp] cec update-type Performs action on a type [alias: utp]

cec create-contentlayout Creates a content layout based on a content type. [alias: ccl] cec add-contentlayout-mapping Creates content type and content layout mapping. [alias: aclm] cec remove-contentlayout-mapping Removes a content layout mapping. [alias: rclm] cec add-field-editor Adds a field editor to a field in a content type. [alias: afe] cec remove-field-editor Removes a field editor from a field in a content type. [alias: rfe] cec migrate-content Migrates content from OCI IC server to EC server. [alias: mc] cec compile-content Compiles the content items generating HTML renditions. [alias: cmpc] cec upload-compiled-content Uploads the compiled content to OCM server. [alias: ulcc]

Recommendations cec download-recommendation Downloads a recommendation from the OCM server. [alias: dlr] cec upload-recommendation Uploads a recommendation to the OCM server. [alias: ulr] cec control-recommendation Performs action on recommendations on OCM server. [alias: ctre]

Taxonomies cec download-taxonomy Downloads a taxonomy from OCM server. [alias: dltx] cec upload-taxonomy Uploads a taxonomy to OCM server. [alias: ultx]

25-6 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine

cec control-taxonomy Performs action on taxonomy on OCM server. [alias: cttx]

Translation cec list-translation-jobs Lists translation jobs. [alias: ltj] cec create-translation-job Creates a translation job for a site or assets on OCM server. [alias: ctj] cec download-translation-job Downloads translation job from OCM server. [alias: dtj] cec submit-translation-job Submits translation job to translation connection . [alias: stj] cec refresh-translation-job Refreshes translation job from translation connection. [alias: rtj] cec ingest-translation-job Gets translated job from translation connection and ingest. [alias: itj] cec upload-translation-job Uploads translation job to OCM server. [alias: utj] cec create-translation-connector Creates translation connector . [alias: ctc] cec start-translation-connector Starts translation connector . [alias: stc] cec register-translation-connector Registers a translation connector. [alias: rtc]

Groups cec create-group Creates an OCM group on OCM server. [alias: cg] cec delete-group Deletes an OCM group on OCM server. [alias: ] cec add-member-to-group Adds users and groups to an OCM group on OCM server. [alias: amtg] cec remove-member-from-group Removes users and groups from an OCM group on OCM server. [alias: rmfg]

Local Environment cec create-encryption-key Create an encryption key to encrypt/decrypt password for servers. [alias: cek] cec register-server Registers a OCM server. [alias: rs] cec set-oauth-token Set OAuth token for a registered server. [alias: sot] cec list Lists local or server resources. [alias: l] cec execute-get Makes an HTTP GET request to a REST API endpoint on OCM server [alias: exeg] cec install Creates source tree. [alias: i] cec develop Starts a test server. [alias: d] cec sync-server Starts a sync server. [alias: scs] cec webhook-server Starts a webhook server. [alias: whs]

25-7 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine

Options: --version, -v Show version number [boolean] --help, -h Show Help

------cec create-folder ------Usage: cec create-folder

Create a folder or folder hierarchy on OCM server. Specify the server with -s or use the one specified in cec.properties file.

Options: --help, -h Show Help --server, -s The registered OCM server

Examples: cec create-folder Projects Creates folder Projects under the Home folder cec create-folder Projects/Blogs Creates folder Projects under the Home folder and folder Blogs under Projects cec create-folder Projects -s SampleServer Creates folder Projects under the Home folder on the registered server SampleServer

------cec share-folder ------Usage: cec share-folder

Shares folder with users and groups on OCM server and assign a role. Specify the server with -s or use the one specified in cec.properties file. The valid roles are

manager contributor downloader viewer

Options: --help, -h Show Help --users, -u The comma separated list of user names --groups, -g The comma separated list of group names --role, -r The role [manager | contributor | downloader | viewer] to assign to the users or groups [required] --server, -s The registered OCM server

Examples: cec share-folder Projects/Blogs -u user1,user2 -r manager Share folder Projects/Blogs with user user1 and user2 and assign Manager role to them cec share-folder Projects/Blogs -u user1,user2 -g group1 -r manager Share folder Projects/Blogs with user user1, user2 and group group1 and assign Manager role to them cec share-folder Projects/Blogs -g group1,group2 -r manager

25-8 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine

Share folder Projects/Blogs with group group1 and group2 and assign Manager role to them cec share-folder Projects/Blogs -u user1,user2 -r manager -s SampleServer Share folder Projects/Blogs with user user1 and user2 and assign Manager role to them on the registered server SampleServer

------cec unshare-folder ------Usage: cec unshare-folder

Deletes user or group access to a shared folder on OCM server. Specify the server with -s or use the one specified in cec.properties file.

Options: --help, -h Show Help --users, -u The comma separated list of user names --groups, -g The comma separated list of group names --server, -s The registered OCM server

Examples: cec unshare-folder Projects/Blogs -u user1,user2 cec unshare-folder Projects/Blogs -g group1,group2 cec unshare-folder Projects/Blogs -u user1,user2 -g group1,group2 cec unshare-folder Projects/Blogs -u user1,user2 -s SampleServer

------cec list-folder ------Usage: cec list-folder

Displays folder and all its content on OCM server. Specify the server with - s or use the one specified in cec.properties file.

Options: --help, -h Show Help --server, -s The registered OCM server

Examples: cec list-folder Releases/1 cec list-folder Releases/1 -s SampleServer cec list-folder site:blog1 cec list-folder theme:blog1Theme cec list-folder component:Comp1/assets

------cec download-folder ------Usage: cec download-folder

Downloads folder and all its content from OCM server. Specify the server with -s or use the one specified in cec.properties file. Optionally specify -f to save the folder on the local system.

Options:

25-9 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine

--help, -h Show Help --folder, -f Local folder to save the folder on OCM server --server, -s The registered OCM server

Examples: cec download-folder Releases/1 Downloads folder Releases/1 from OCM server and save to local folder src/ documents/ cec download-folder / Downloads all documents from OCM server and save to local folder src/documents/ cec download-folder Releases/1 -s SampleServer Downloads folder Releases/1 from the registered server SampleServer and save to local folder src/documents/ cec download-folder Releases/1 -f ~/Downloads Downloads folder Releases/1 from OCM server and save to local folder ~/Download/ cec download-folder Releases/1 -f . Downloads folder Releases/1 from OCM server and save to the current local folder cec download-folder site:blog1 -f ~/Downloads/blog1Files Downloads all files of site blog1 and save to local folder ~/Download/blog1Files cec download-folder theme:blog1Theme Downloads all files of theme blog1Theme and save to local folder src/documents/ blog1Theme/ cec download-folder component:Comp1/assets Downloads all files in folder assets of component Comp1 and save to local folder src/documents/Comp1/assets/

------cec upload-folder ------Usage: cec upload-folder

Uploads folder and all its content to OCM server. Specify the server with -s or use the one specified in cec.properties file. Optionally specify -f to set the parent folder on OCM server.

Options: --help, -h Show Help --folder, -f The parent folder on OCM server --server, -s The registered OCM server

Examples: cec upload-folder ~/Downloads/docs Uploads all content from ~/Downloads/docs to folder docs on the server cec upload-folder ~/Downloads/docs/ Uploads all content from ~/Downloads/docs to the Home folder on the server cec upload-folder ~/Downloads/docs -f Mydoc Uploads all content from ~/Downloads/docs to folder Mydoc/docs on the server cec upload-folder ~/Downloads/docs/ -f Mydoc Uploads all content from ~/Downloads/docs to folder Mydoc on the server cec upload-folder ~/Downloads/docs -s SampleServer Uploads all content from ~/ Downloads/docs to folder docs on the registered server SampleServer cec upload-folder ~/Downloads/docs/ -f site:blog1/settings/misc

25-10 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine

Uploads all content from ~/Downloads/docs to folder settings/misc of site blog1 cec upload-folder ~/Downloads/docs -f theme:blog1Theme Uploads all content from ~/Downloads/docs to folder docs of theme blog1Theme cec upload-folder ~/Downloads/docs -f component:Comp1 Uploads all content from ~/Downloads/docs to folder docs of component Comp1

------cec delete-folder ------Usage: cec delete-folder

Deletes folder and all its content on OCM server. Specify the server with -s or use the one specified in cec.properties file. Optionally specify -p to permanently delete the folder.

Options: --help, -h Show Help --server, -s The registered OCM server --permanent, -p Delete the folder permanently

Examples: cec delete-folder Import/docs cec delete-folder Import/docs -s SampleServer cec delete-folder Import/docs -p cec delete-folder site:blog1/docs cec delete-folder theme:blog1Theme/docs cec delete-folder component:Comp1/docs

------cec download-file ------Usage: cec download-file

Downloads file from OCM server. Specify the server with -s or use the one specified in cec.properties file. Optionally specify -f to save the file on the local system.

Options: --help, -h Show Help --folder, -f Local folder to save the file --server, -s The registered OCM server

Examples: cec download-file Releases/Projects.pdf Downloads the file from OCM server and save to local folder src/documents/ cec download-file Releases/Projects.pdf -s SampleServer Downloads the file from the registered server SampleServer and save to local folder src/documents/ cec download-file Releases/Projects.pdf -f ~/Downloads Downloads the file from OCM server and save to local folder ~/Download/ cec download-file Releases/Projects.pdf -f . Downloads the file from OCM server and save to the current local folder cec download-file site:blog1/siteinfo.json Downloads the file from folder blog1 and save to local folder src/documents/blog1

25-11 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine

cec download-file theme:blog1Theme/designs/default/design.css Downloads the css file from folder designs/default of theme blog1Theme and save to local folder src/documents/blog1Theme/designs/default/ cec download-file component:Comp1/assets/render.js Downloads the js file from folder assets of component Comp1 and save to local folder src/documents/Comp1/assets/

------cec upload-file ------Usage: cec upload-file

Uploads file to OCM server. Specify the server with -s or use the one specified in cec.properties file. Optionally specify -f to set the parent folder on OCM server.

Options: --help, -h Show Help --folder, -f The parent folder on OCM server --server, -s The registered OCM server

Examples: cec upload-file ~/Documents/ Projects.pdf Uploads the file to the Home folder cec upload-file ~/Documents/Projects.pdf -s SampleServer Uploads the file to the Home folder on the registered server SampleServer cec upload-file ~/Documents/Projects.pdf -f Doc/ Plan Uploads the file to folder Doc/Plan cec upload-file ~/Documents/Projects.pdf -f site:blog1/settings/ misc Uploads the file to folder settings/misc of site blog1 cec upload-file ~/Documents/style1.css -f theme:blog1Theme/designs/ default Uploads the css file to folder designs/default of theme blog1Theme cec upload-file ~/Documents/comp1.js -f component:Comp1/ assets Uploads the js file to folder assets of component Comp1

------cec delete-file ------Usage: cec delete-file

Deletes file on OCM server. Specify the server with -s or use the one specified in cec.properties file. Optionally specify -p to permanently delete the file.

Options: --help, -h Show Help --server, -s The registered OCM server --permanent, -p Delete the file permanently

Examples: cec delete-file docs/Projects.pdf

25-12 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine

cec delete-file docs/Projects.pdf -s SampleServer cec delete-file docs/Projects.pdf -p cec delete-file site:blog1/docs/Projects.pdf cec delete-file theme:blog1Theme/docs/Projects.pdf cec delete-file component:Comp1/docs/Projects.pdf

------cec create-component ------Usage: cec create-component

Creates the component . By default, it creates a local component. Optionally specify -f to create from a different source.

Valid values for are: local local-template local-iframe remote sectionlayout Sample-File-List Sample-Folder-List Sample-Documents-Manager Sample-Process-Start-Form Sample-Process-Task-List Sample-Process-Task-Details Sample-Stocks-Embedded Sample-Text-With-Image Sample-To-Do Anchor ContentForm Document-Search JET-CCA-Demo-Card MapFieldEditor Sample-OPA-Interview SimpleHTML SliderFieldEditor TextFieldEditor

Options: --help, -h Show Help --from, -f Source to create from

Examples: cec create-component Comp1 cec create-component Comp2 -f Sample-File-List

------cec copy-component ------Usage: cec copy-component []

Copies an existing component named to . is a folder name from src/components

25-13 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine

Options: --help, -h Show Help

Examples: cec copy-component Sample-To-Do Comp1 Copies Sample-To-Do to Comp1.

------cec import-component ------Usage: cec import-component

Imports a component from . Specify the absolute path of the zip file. The zip file name will be used as the component name.

Options: --help, -h Show Help

Examples: cec import-component /home/Comp1.zip Imports the component Comp1.

------cec export-component ------Usage: cec export-component

Exports the component as a zip file.

Options: --help, -h Show Help

Examples: cec export-component Sample-To-Do Exports the component Sample-To-Do.

------cec download-component ------Usage: cec download-component

Downloads the components from the Content Management server. Specify the server with -s or use the one specified in cec.properties file.

Options: --help, -h Show Help --server, -s The registered OCM server

Examples: cec download-component Sample-To-Do cec download-component Sample-To-Do,Sample-To-Do2 cec download-component Sample-To-Do -s SampleServer

------cec upload-component ------

25-14 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine

Usage: cec upload-component

Uploads the components to the Content Management server. Specify the server with -s or use the one specified in cec.properties file. Optionally specify -p to publish the component after deploy. Optionally specify -f to set the folder to upload the component zip file.

Options: --help, -h Show Help --folder, -f Folder to upload the component zip file --publish, -p Publish the component --server, -s The registered OCM server

Examples: cec upload-component Sample-To-Do Uploads the component Sample-To-Do to the server specified in cec.properties. cec upload-component Sample-To-Do -s SampleServer Uploads the component Sample-To-Do to the registered server SampleServer. cec upload-component Sample-To-Do -p Uploads and publishes the component Sample-To-Do. cec upload-component Sample-To-Do,Sample-To-Do2 Uploads component Sample-To-Do and Sample-To-Do2. cec upload-component Sample-To-Do -f Import/Components Uploads file Sample-To-Do.zip to folder Import/Components and imports the component Sample-To-Do.

------cec control-component ------Usage: cec control-component

Perform on components on OCM server. Specify the components with -c . Specify the server with -s or use the one specified in cec.properties file. The valid actions are

publish

Options: --help, -h Show Help --components, -c The comma separated list of components [required] --server, -s The registered OCM server

Examples: cec control-component publish -c Comp1 Publish component Comp1 on the server specified in cec.properties file cec control-component publish -c Comp1 -s SampleServer Publish component Comp1 on the registered server SampleServer cec control-component publish -c Comp1,Comp2 -s SampleServer Publish component Comp1 and Comp2 on the registered server SampleServer

------cec share-component ------

25-15 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine

Usage: cec share-component

Shares component with users and groups on OCM server and assign a role. Specify the server with -s or use the one specified in cec.properties file. The valid roles are

manager contributor downloader viewer

Examples: cec share-component Comp1 -u user1,user2 -r manager Share component Comp1 with user user1 and user2 and assign Manager role to them cec share-component Comp1 -u user1,user2 -g group1,group2 -r manager Share component Comp1 with user user1 and user2 and group group1 and group2 and assign Manager role to them cec share-component Comp1 -u user1,user2 -r manager -s SampleServer Share component Comp1 with user user1 and user2 and assign Manager role to them on the registered server SampleServer

------cec unshare-component ------Usage: cec unshare-component

Deletes user or group access to a component on OCM server. Specify the server with -s or use the one specified in cec.properties file.

Options: --help, -h Show Help --users, -u The comma separated list of user names --groups, -g The comma separated list of group names --server, -s The registered OCM server

Examples: cec unshare-component Comp1 -u user1,user2 cec unshare-component Comp1 -u user1,user2 -g group1,group2 cec unshare-component Comp1 -u user1,user2 -s SampleServer

------cec create-template ------Usage: cec create-template

25-16 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine

Creates the template . By default, it creates a StarterTemplate. Optionally specify -f to create from different source.

Valid values for are: CafeSupremoLite JETStarterTemplate StarterTemplate BlogTemplate VBCSSamplesTemplate search_template

To create template based on a site on OCM server, specify -s and specify the server with -r or use the one specified in cec.properties file.

Options: --help, -h Show Help --from, -f Source to create from --site, -s Site to create from --excludecontent, -x Exclude content --enterprisetemplate, -e Enterprise template --server, -r The registered OCM server

Examples: cec create-template Temp1 cec create-template Temp2 -f CafeSupremoLite cec create-template Temp1 -s Site1 Create template Temp1 based on site Site1 on OCM server cec create-template Temp1 -s Site1 -x Create template Temp1 based on site Site1 on OCM server and exclude the content in the site cec create-template Temp1 -s Site1 -r SampleServer Create template Temp1 based on site Site1 on the registered server SampleServer cec create-template EnterpriseTemp1 -s StandardSite1 -e Create enterprise template EnterpriseTemp1 based on standard site StandardSite1 on OCM server

------cec create-template-from-site ------Usage: cec create-template-from-site

Creates the template from site on the Content Management server. Specify the server with -r or use the one specified in cec.properties file. Optionally specify to include unpublished content items and digital assets in your template.

Options: --help, -h Show Help --site, -s Site to create from [required] --includeunpublishedassets, -i flag to indicate to include unpublished content items and digital assets in your template --enterprisetemplate, -e Enterprise template --server, -r The registered OCM server

Examples: cec create-template-from-site BlogTemplate -s BlogSite

25-17 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine

cec create-template-from-site BlogTemplate -s BlogSite -r SampleServer cec create-template-from-site BlogTemplate -s BlogSite -i -r SampleServer cec create-template-from-site EnterpriseTemplate -s StandardSite -e

------cec download-template ------Usage: cec download-template

Downloads the template from the Content Management server. Specify the server with -s or use the one specified in cec.properties file.

Options: --help, -h Show Help --server, -s The registered OCM server

Examples: cec download-template BlogTemplate cec download-template BlogTemplate -s SampleServer

------cec compile-template ------Usage: cec compile-template

Compiles all the pages within the site of the template and places the compiled pages under the sites assets folder. Optionally specify -s to make content queries against this server (requires channelToken). Optionally specify -c to use this channelToken when generating any content URLs. Optionally specify -t [draft | published] content to retrieve from the server type, defaults to published. Optionally specify -p the set of pages to compile. Optionally specify -d to start the compilation with --inspect- brk flag. Optionally specify -r recurse through all child pages of specified pages. Optionally specify -l include default locale when creating pages. Optionally specify -a [desktop | mobile] target device type when using adaptive layouts. Optionally specify -v to display all warning messages during compilation. Optionally specify -i ignore compilation errors when calculating the exit code for the process.

Options: --help, -h Show Help --server, -s The registered OCM server --channelToken, -c The channel access token to use for content URLs

25-18 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine

--type, -t The type of content to retrieve from the serve [published | draft] --pages, -p The list of pages to compile --recurse, -r Compile all child pages of those specifed in the page list --debug, -d Start the compiler with "--inspect-brk" option to debug compilation --noDetailPages, -e Do not generate compiled detail pages --noDefaultDetailPageLink, -o Do not generate compiled detail page for items/content lists that use the default detail page --targetDevice, -a The target device type when using adaptive layouts [desktop | mobile] --siteName, -n The target site name to use when compiling the template --secureSite, -u The target site is a secure site --includeLocale, -l Include default locale when creating pages --verbose, -v Run in verbose mode to display all warning messages during compilation. --ignoreErrors, -i Ignore compilation errors when calculating the exit code for the process.

Examples: cec compile-template Temp1 Compiles the site in template Temp1 using content stored in the template. cec compile-template Temp1 -c channelToken Compiles the site in template Temp1 using the given channelToken for any content URLs. cec compile-template Temp1 -c channelToken -s SampleServer -t draft Compiles the site in template Temp1 retrieving draft content from the specified server. cec compile-template Temp1 -p 104,112,183 -r Compiles the specified pages in the site in template Temp1 including all child pages. cec compile-template Temp1 -d Waits for the debugger to be attached. Once attached, compiles the site in template Temp1.

------cec copy-template ------Usage: cec copy-template []

Copies an existing template named to . is a folder name from src/templates

Options: --help, -h Show Help

Examples: cec copy-template Temp1 Temp2 Copies Temp1 to Temp2.

------cec import-template ------Usage: cec import-template

Imports a template from . Specify the absolute path of the zip file. The zip file name will be used as the template name.

25-19 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine

Options: --help, -h Show Help

Examples: cec import-template /home/Temp1.zip Imports the template Temp1.

------cec export-template ------Usage: cec export-template

Exports the template as a zip file and provides the location of the zip file.

Options: --help, -h Show Help --optimize, -o Optimize the template

Examples: cec export-template Temp1 Exports the template Temp1.

------cec upload-template ------Usage: cec upload-template

Uploads the template to the Content Management server. Specify the server with -s or use the one specified in cec.properties file. Optionally specify -f to set the folder to upload the template zip file. Optionally specify -p to publish theme and components after import.

Options: --help, -h Show Help --folder, -f Folder to upload the template zip file --server, -s The registered OCM server --optimize, -o Optimize the template --excludecontenttemplate, -x Exclude content template --excludecomponents, -e Exclude components --publish, -p Publish theme and components

Examples: cec upload-template StarterTemplate Uploads the template StarterTemplate. cec upload-template StarterTemplate -s SampleServer Uploads the template StarterTemplate to the registered server SampleServer. cec upload-template StarterTemplate -f Import/Templates Uploads file StarterTemplate.zip to folder Import/Templates and imports the template StarterTemplate. cec upload-template StarterTemplate -p Publish the theme and all components in StarterTemplate.zip after import cec upload-template StarterTemplate -o Optimizes

25-20 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine and uploads the template StarterTemplate. cec upload-template StarterTemplate -x Exclude the "Content Template" from the template upload. "Content Template" upload can be managed independently. cec upload-template StarterTemplate -e Exclude all components from the template upload. Components can be uploaded independently.

------cec delete-template ------Usage: cec delete-template

Deletes the template on the Content Management server. Specify the server with -s or use the one specified in cec.properties file. Optionally specify -p to permanently delete the template.

Options: --help, -h Show Help --server, -s The registered OCM server --permanent, -p flag to indicate to permanently delete the template

Examples: cec delete-template BlogTemplate cec delete-template BlogTemplate -p cec delete-template BlogTemplate -s SampleServer

------cec share-template ------Usage: cec share-template

Shares template with users and groups on OCM server and assign a role. Specify the server with -s or use the one specified in cec.properties file. The valid roles are

manager contributor downloader viewer

Examples: cec share-template Template1 -u user1,user2 -r manager Share template Template1 with user user1 and user2 and assign Manager role to them cec share-template Template1 -u user1,user2 -g group1,group2 -r manager

25-21 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine

Share template Template1 with user user1 and user2 and group group1 and group2 and assign Manager role to them cec share-template Template1 -u user1,user2 -r manager -s SampleServer Share template Template1 with user user1 and user2 and assign Manager role to them on the registered server SampleServer

------cec unshare-template ------Usage: cec unshare-template

Deletes user or group access to a template on OCM server. Specify the server with -s or use the one specified in cec.properties file.

Options: --help, -h Show Help --users, -u The comma separated list of user names --groups, -g The comma separated list of group names --server, -s The registered OCM server

Examples: cec unshare-template Template1 -u user1,user2 cec unshare-template Template1 -u user1,user2 -g group1,group2 cec unshare-template Template1 -u user1,user2 -s SampleServer

------cec update-template ------Usage: cec update-template

Performs action on a local template. Optionally specify -c for other local content. The valid actions are

rename-asset-id

Options: --help, -h Show Help --template, -t The template [required] --content, -c The comma separated list of local content

Examples: cec update-template rename-asset-id -t Template1 cec update-template rename-asset-id -t Template1 -c Content1,Content2

------cec describe-template ------Usage: cec describe-template

Describes the template package such as theme, components and content types.

Options:

25-22 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine

--help, -h Show Help

Examples: cec describe-template StarterTemplate Describes the template StarterTemplate package

------cec create-template-report ------Usage: cec create-template-report

Generates an asset usage report for the template package. Optionally specify -o to save the report to a json file.

Options: --help, -h Show Help --includepagelinks, -i Include validating page links --output, -o Output the report to a JSON file

Examples: cec create-template-report StarterTemplate cec create-template-report StarterTemplate - o The report will be saved to StarterTemplateAssetUsage.json at the current local location cec create-template-report StarterTemplate -o ~/ Documents The report will be saved to ~/ Documents/StarterTemplateAssetUsage.json cec create-template-report StarterTemplate -o ~/Documents/ StarterTemplateReport.json The report will be saved to ~/Documents/ StarterTemplateReport.json cec create-template-report StarterTemplate - i Include validating page links

------cec add-component-to-theme ------Usage: cec add-component-to-theme

Adds a component to a theme. Optionally specify -c to set the component category.

Options: --help, -h Show Help --theme, -t Theme [required] --category, -c component category

Examples: cec add-component-to-theme Sample-To-Do -t BlogTheme cec add-component-to-theme Sample-To-Do -t BlogTheme -c Samples

------cec remove-component-from-theme ------Usage: cec remove-component-from-theme

25-23 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine

Removes a component from a theme.

Options: --help, -h Show Help --theme, -t Theme [required]

Examples: cec remove-component-from-theme Sample-To-Do -t BlogTheme

------cec control-theme ------Usage: cec control-theme

Perform on theme on OCM server. Specify the theme with -t . Specify the server with -s or use the one specified in cec.properties file. The valid actions are

publish

Options: --help, -h Show Help --theme, -t The theme [required] --server, -s The registered OCM server

Examples: cec control-theme publish -t Theme1 Publish theme Theme1 on the server specified in cec.properties file cec control-theme publish -t Theme1 -s SampleServer Publish theme Theme1 on the registered server SampleServer

------cec share-theme ------Usage: cec share-theme

Shares theme with users and groups on OCM server and assign a role. Specify the server with -s or use the one specified in cec.properties file. The valid roles are

manager contributor downloader viewer

25-24 Chapter 25 Set Up Oracle Content Management Toolkit on Your Local Machine

Examples: cec share-theme Theme1 -u user1,user2 -r manager Share theme Theme1 with user user1 and user2 and assign Manager role to them cec share-theme Theme1 -u user1,user2 -g group1,group2 -r manager Share theme Theme1 with user user1 and user2 and group group1 and group2 and assign Manager role to them cec share-theme Theme1 -u user1,user2 -r manager -s SampleServer Share theme Theme1 with user user1 and user2 and assign Manager role to them on the registered server SampleServer

------cec unshare-theme ------Usage: cec unshare-theme

Deletes user or group access to a theme on OCM server. Specify the server with -s or use the one specified in cec.properties file.

Options: --help, -h Show Help --users, -u The comma separated list of user names --groups, -g The comma separated list of group names --server, -s The registered OCM server

Examples: cec unshare-theme Theme1 -u user1,user2 cec unshare-theme Theme1 -u user1,user2 -g group1,group2 cec unshare-theme Theme1 -u user1,user2 -s SampleServer

------cec create-site ------Usage: cec create-site

Create Enterprise Site on OCM server. Specify the server with -s or use the one specified in cec.properties file.

Options: --help, -h Show Help --template, -t