authoring-articles-catalog-manager by Writing Samples

Oracle Information Development Authoring Articles with Catalog Manager

Publication Status Report F44687-08 June 2025

Oracle Information Development Authoring Articles with Catalog Manager, Publication Status Report F44687-08 Copyright © 2021, 2025, Oracle and/or its affiliates. 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, software documentation, data (as defined in the Federal Acquisition Regulation), 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," "commercial computer software documentation," or "limited rights data" 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, MySQL, and NetSuite 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 1

Learning the articles and article catalog basics What's an article?

1-1

What's an article catalog?

1-1

What are catalog versions and when to version an article catalog? What are article filters?

1-2

Which filter metadata can be assigned to article publications?

1-3

How is filter metadata assigned and how is it applied to article publications?

1-3

When to build articles and the article catalog and what gets built

1-3

Working in the Catalog Manager Tool

1-4

Catalog Product and Release

1-4

Save the Catalog

1-5

Catalog Context Menu

1-5

Catalog Title

1-5

Catalog Information

1-6

Catalog Tree

1-6

Catalog Workspace

1-7

Tree Context Menu

1-7

Article Context Menus

1-8

Creating and Managing Article Publications Create an Article Publication

2-1

Create Versions of Article Publications

2-1

From Catalog Manager

2-2

In Jarvis

2-2

Delete a Published Article

1-1

2-3

Assigning Filters to Article Publications Assign Filter Metadata when Creating Article Publications

3-1

Assign Filter Metadata to Existing Article Publications

3-1

Manage the Filters or Filter Values Assigned to a Product

3-2

iii

Managing and Organizing Article Catalogs Open Catalog Manager

4-1

Create a Catalog

4-1

Enter the PDF Cover Page in Catalog Manager

4-1

Organize Articles in a Catalog

4-2

Change the Title of an Article Catalog

4-4

Create a Release Candidate of a Catalog

4-4

Make a Copy of a Catalog

4-5

Restore an Article Catalog to a Previous State

4-5

View the Catalog GUID

4-5

Building Articles and the Article Catalog Manage the versioning and building of articles from the catalog

5-1

Build Articles to Non-Final UAT

5-1

From Catalog Manager

5-1

In Jarvis

5-2

Build a Catalog to Non-Final UAT

5-3

Send a Catalog to Oracle Review

5-3

Build Articles to Final UAT

5-4

From Catalog Manager

5-4

In Jarvis

5-4

Send Final Articles to Machine Translation

5-4

From Catalog Manager

5-5

In Jarvis

5-5

Create a Release Candidate of a Catalog

5-5

Build a Catalog to Final UAT and Generate PDF Output

5-6

Build a Catalog to Final UAT

5-6

Enter the PDF Cover Page the First Time a Catalog is Built

5-6

Update the PDF Cover Page for Subsequent Builds

5-7

Send the Final Catalog to Machine Translation

5-7

Promote Articles from Final UAT to Stage

5-8

Promote a Catalog from Final UAT to Stage

5-8

Build Articles Directly to Stage

5-8

Create a Release Candidate of a Catalog

5-9

Build a Catalog Directly to Stage and Generate PDF Output

5-9

Build a Catalog Directly to Stage

5-10

Enter the PDF Cover Page the First Time a Catalog is Built

5-10

Update the PDF Cover Page for Subsequent Builds

5-10

Promote Articles from Stage to Production

5-11

Promote a Catalog from Stage to Production

5-11

1 Learning the articles and article catalog basics Authoring articles uses the standard authoring and publishing tools of Jarvis, SDL Knowledge Center, and Oxygen 17.1. Authoring article catalogs uses the Catalog Manager tool.

What's an article? An article is a set of typically 3 to 10 topics that cover a specific user goal. Articles are presented as single HTML pages, so that the user can read everything about a user goal in one place. Articles can be tagged with metadata, so that users can filter the content by their role (audience), configuration, or environment. Individual articles can be updated and published to OHC without publishing all articles for the product. Always publish articles before publishing the catalog. Related Topics •

Create an Article Publication Quickly create an SDL publication including the part number, doc ID, article submap, and repository folders in SDL.

What's an article catalog? An article catalog organizes a collection of articles into a hierarchy. Topic headings can be use to group articles into work flow tasks like Get Started, Plan, Install and Upgrade, etc. Metadata on articles can be updated in Jarvis then applied to published articles by publishing the catalog. In this way, articles only need to be republished when there are content changes. Always publish the catalog after publishing updated articles. Related Topics •

Create a Catalog After you build the articles with the same metadata as the catalog in Jarvis UAT, create the catalog.

Related Topics •

Create a Release Candidate of a Catalog When a catalog is complete and release-ready, create a release candidate of an article catalog.

What are catalog versions and when to version an article catalog? Catalog versions and statuses help you track your content readiness and which catalog versions have been built to production. Each catalog has one development (dev) version and multiple production (prod-n) versions. Production versions can have a Release Candidate or Released status.

1-1

Chapter 1

What are article filters?

Use the development version to update the catalog for a new release and build content to nonFinal UAT. When your content is frozen and ready for the final UAT build, promote or create a Release Candidate in Catalog Manager, taking note of the specific production version created, such as prod-9. Build that production version of the catalog to final UAT, then promote it to Stage and Production. When a Release Candidate is built to production, it's status changes to Released and that catalog version can no longer be edited or built. We recommend that you update only the development version of the catalog.

What are article filters? By assigning filter metadata to article publications, users can filter articles to hide or show content that applies to their role, product setup, or environment. Related Topics •

Assign Filter Metadata when Creating Article Publications You can assign filter metadata at the same time that you are creating article publications.

•

Assign Filter Metadata to Existing Article Publications You can assign or update filter metadata to existing article publications.

1-2

Chapter 1

When to build articles and the article catalog and what gets built

Which filter metadata can be assigned to article publications? The metadata fields for content filters are audience, configuration, and environment. The metadata values for each field are specific to each product or group of products. The metadata values are defined by product teams in coordination with the InfoDev IAs to keep the list of values to a minimum and avoid inconsistency in terms. Audience metadata defines the different roles of users. While a person can be in multiple roles, each task should be specific to a single role. Configuration metadata defines different ways that the settings or components of a product can be set up. A configuration is usually exclusive to other configurations. Environment metadata defines the hardware or software that the product is running on or in. An environment is usually exclusive meaning a product can run only in one environment at a time.

How is filter metadata assigned and how is it applied to article publications? Filter metadata is applied to article publications when they are built or if already published when the article catalog is built. Assign filter metadata at the article publication level because content filters hide or show the entire article and cannot filter content within an article. Multiple metadata values can be assigned to the same article publication, but do so only when all content within the article applies to them.

When to build articles and the article catalog and what gets built Whether to rebuild articles or the catalog depends on whether you updated article content, metadata filters, or the which articles appear in the catalog. You can rebuild updated article publications without rebuilding the article catalog as long as those publications exist in the published catalog.

Figure 1-1

Build articles to update content without building the catalog

You can assign or change the metadata filters for published article publications, then apply the new metadata by building the article catalog. Because the metadata is stored in the catalog, you don't need to rebuild the publications to update the filters.

Figure 1-2

Build the catalog to apply filter metadata without republishing articles

1-3

Chapter 1

Working in the Catalog Manager Tool When you add or remove articles or topic headings in the catalog, build the catalog to see the organization in the published catalog.

Figure 1-3

Build the catalog to reflect the addition or removal of articles

When you add or update the PDF cover page information in the catalog, build the catalog to Final UAT to see the updated information in the published catalog PDF file.

Figure 1-4 Build the catalog to Final UAT to reflect updated PDF cover page information

Related Topics •

Build Articles to Non-Final UAT The first-time you build article publications to non-Final UAT, you must build them in Jarvis before they appear in the catalog. You can build existing articles or new versions of existing articles to non-Final UAT from Catalog Manager or Jarvis.

•

Build a Catalog to Non-Final UAT Build the development version of the catalog to non-Final UAT to update the catalog hierarchy or apply updated content filters to articles in the catalog.

•

Build Articles Directly to Stage For small changes that don't require a technical review, you can skip UAT and build articles directly to Stage.

•

Build a Catalog Directly to Stage and Generate PDF Output Building directly to Stage always generate PDF output of the article catalog.

Working in the Catalog Manager Tool Catalog Manager enables you to organize individual article publications into a hierarchy using topic headings.

Catalog Product and Release You can create one catalog for each product and release under an SSOT base path. You use the product and release from the associated SSOT base path to open a catalog.

1-4

Chapter 1

Working in the Catalog Manager Tool The SSOT base path for this catalog is sptest | test-suite | test-product-group | test-product | test-release. To open this catalog, enter test-product and test-release.

Save the Catalog Be sure to save the catalog after making changes and before navigating to another page to avoid losing your changes. The system doesn't prompt you when there are unsaved changes.

A backup is created each time you save the catalog. Backups can be restored for any save point.

Catalog Context Menu Use the context menu for the catalog to create or duplicate a catalog.

Catalog Title The catalog title is set when you create a catalog and can be changed in Jarvis.

1-5

Chapter 1

Working in the Catalog Manager Tool

Catalog Information Use Catalog Information to enter information that appears on the cover and copyright pages of the PDF output. A Catalog Information page appears in Jarvis the first time you build an article catalog if you haven't already entered the information in Catalog Manager.

Catalog Tree The catalog tree defines the organization of the topic headings and articles in the catalog.

1-6

Chapter 1

Working in the Catalog Manager Tool

Catalog Workspace The catalog workspace includes the articles available to be placed in the catalog tree, shows which articles are in the tree, and allows you to view where in the tree articles are located.

Tree Context Menu The context menu in the catalog tree allows you to build selected articles to UAT or create versions of article publications and optionally update their metadata at the same time.

1-7

Chapter 1

Working in the Catalog Manager Tool

Article Context Menus The context menus for articles allow you to version article publications in the tree, remove them from the tree, and view published articles in the UAT environment.

1-8

2 Creating and Managing Article Publications Quickly create, version, and make copies of article publications including the publication details like doc ID and part number.

Note: These instructions assume that you already know how to work with and self-publish SDL publications.

Create an Article Publication Quickly create an SDL publication including the part number, doc ID, article submap, and repository folders in SDL. You must have the DOCENG_PRODUCT_SOLUTIONS entitlement to access the QPC menu. You must also have the appropriate product-level entitlements. 1.

In Jarvis, select Create SDL Publication from the QPC menu.

Select Article as the Publication Type, select the SSOT base path for the associated product and release, then click Submit.

Enter the PDB metadata, then click Submit.

Enter the publication metadata including filter values as needed, then click Submit.

Click Create Publication. A doc ID and part number are created and assigned to the new publication. The publication has an article submap in it and is located in the SDL folder path associated with the SSOT base path.

Make a note of the publication details including its GUID, folder path, doc ID, and part number.

Related Topics •

Create Versions of Article Publications You can create a version of one or more existing SDL publications from an article catalog or in Jarvis. Revisions are created for the associated part numbers automatically. You can update and apply metadata to one or all of the selected publications before you version them.

2-1

Chapter 2

Create Versions of Article Publications

Before you begin You must have the DOCENG_PRODUCT_SOLUTIONS entitlement to access the QPC menu. You must also have the appropriate product-level entitlements.

Create Versions of Article Publications from Catalog Manager You can quickly create a version of one, multiple, or all article publications from within an article catalog. 1.

Open the catalog in Catalog Manager.

In the tree, select one or more articles to version or click Select All to select all articles placed in the catalog.

Select Version SDL Publication from the Tree context menu.

Update the metadata values as needed:

Note: The OHC base path fields (Category, Suite, Group, Product, Release, Component, Platform) cannot be changed. a.

Click Update Metadata and make changes to the metadata.

To apply the changes to the current publication only, click Save Update. To apply the changes to all selected publications, click Apply to All and Save. Status changes to "Updated" on affected publications.

Click Create New Versions. A new version of the SDL publications are created. A new revision is created for the associated part numbers.

To continue working in your catalog, click Return to Catalog Manager.

Create Versions of Article Publications in Jarvis You can quickly create a version of one or more existing SDL publications that have matching search criteria. 1.

In Jarvis, select Version SDL Publication from the QPC menu.

Find the article publication using one of these methods: •

Enter the title, GUID, or doc ID of the publication.

•

Enter the first and last name of the pub owner defined in PDB.

•

Select the SSOT elements associated with the publication under Advanced Search.

To include previous versions in the search results, deselect Only show latest version.

Click Search to return a list of matching publications.

Select one or more publications, then click Next.

Update the metadata values as needed:

2-2

Chapter 2

Delete a Published Article

Note: The OHC base path fields (Category, Suite, Group, Product, Release, Component, Platform) cannot be changed. a.

Click Update Metadata and make changes to the metadata.

Click Create New Versions. A new version of the SDL publications are created. A new revision is created for the associated part numbers.

To version another article, click Return to Jarvis Home Page.

Delete a Published Article Deleting a published article from OHC can take a few weeks, but you can remove it from the published catalog on-demand. You delete an article publication the same way you delete any other publication. Allow a minimum of three weeks for the content to be removed. Don't use the Remove Obsolete Publications command in Jarvis because additional steps are required. Doc Eng performs all the necessary steps when you clone the template tickets. 1.

Remove the article publication from the catalog.

Build the catalog.

Remove the article from OHC. •

If the content has been promoted to production, then clone DPS-28956. Follow the instructions in the ticket.

•

If the content hasn't been promoted to production, then clone DPS-53922. Follow the instructions in the ticket.

2-3

3 Assigning Filters to Article Publications You can assign filter metadata to new or existing article publications.

Assign Filter Metadata when Creating Article Publications You can assign filter metadata at the same time that you are creating article publications. You must have the DOCENG_PRODUCT_SOLUTIONS entitlement to access the QPC menu. You must also have the appropriate product-level entitlements. 1.

In Jarvis, select Create SDL Publication from the QPC menu.

Select Article as the Publication Type, select the SSOT base path for the associated product and release, then click Submit.

Enter the PDB metadata, then click Submit.

Enter the publication metadata as needed.

Select the appropriate metadata values in Audience, Configuration, and Environment as needed, then click Submit.

Make a note of the publication details including its GUID, folder path, doc ID, and part number.

Related Topics •

What are article filters? By assigning filter metadata to article publications, users can filter articles to hide or show content that applies to their role, product setup, or environment.

Assign Filter Metadata to Existing Article Publications You can assign or update filter metadata to existing article publications. 1.

In Jarvis, select SDL from the Assign Metadata menu.

Find articles using one of these methods: •

Enter the doc ID, GUID, or title of a single article.

•

Select a search tag.

•

Select SSOT elements and content type or enter other search criteria under Advanced Search.

Select the articles to update, then click Next.

Select the appropriate metadata values in Audience, Configuration, and Environment as needed.

3-1

Chapter 3

Manage the Filters or Filter Values Assigned to a Product Related Topics •

What are article filters? By assigning filter metadata to article publications, users can filter articles to hide or show content that applies to their role, product setup, or environment.

Manage the Filters or Filter Values Assigned to a Product You can make a request to add, change, or remove the filters or filter values that can be assigned to the article publications associated with a specific product.

•

Clone the ticket template (DPS-90387) and follow the instructions.

3-2

4 Managing and Organizing Article Catalogs Work with article catalogs in Catalog Manager, and then build them in Jarvis.

Open Catalog Manager The Catalog Manager URL is provided during onboarding. Log in with your SSO user name and password.

Create a Catalog After you build the articles with the same metadata as the catalog in Jarvis UAT, create the catalog. 1.

In Jarvis, go to the Catalog Manager tool.

Click the Catalog context menu, then select Create Catalog. a.

In Title, enter the catalog title.

In Description, enter information to describes the purpose or scope of the catalog. The description doesn't appear externally.

Under Metadata, select the SSOT base path for the product and release associated with the catalog.

Before you click the Create Catalog button, make a note of the Pub GUID (Catalog GUID); for example, TEST-PRODUCT-GROUP-ARTICLE-CATALOG-LATEST. It's helpful to know the catalog GUID when building the catalog in Jarvis.

Click Create Catalog. Articles with the same product metadata that you have built to UAT appear in the Workspace.

Related Topics •

Enter the PDF Cover Page in Catalog Manager Enter what you want to appear on the cover and copyright pages of the PDF output directly in Catalog Manager. If this information isn't entered here, you will be prompted to enter it in Jarvis the first time you build an article catalog whether you are building to Final UAT or directly to Stage. 1.

In Jarvis, go to the Catalog Manager tool.

In Catalog Manager, enter the product and release segments associated with the catalog.

Click the Tree context menu, then select Catalog Information.

4-1

Chapter 4

Organize Articles in a Catalog 4.

Enter information for the cover and copyright pages of the PDF output: a.

Enter the full product name; for example, "Oracle Autonomous Database."

Enter the product release information, for example, "Release 23.4.1," "23.c," or leave blank.

Enter the platform information; for example, "on Dedicated Exadata Infrastructure" or leave blank.

Enter the product release information, for example, "Release 15.2" or leave blank.

Enter the platform information; for example, "for Linux" or leave blank.

Select the month and year that the catalog is being published.

In Copyright First Year, select the first year that the catalog was published.

In Copyright Last Year, select the current year that the catalog is being published if it differs from the first year the catalog was published.

Enter the first and last name of primary authors as needed.

Enter the first and last name of contributing authors as needed.

Enter the first and last or team name of contributors as needed.

Click Save to save your changes.

Organize Articles in a Catalog Use drag-and-drop to add and move articles and topic heading folders to create the desired catalog hierarchy. 1.

In Jarvis, go to the Catalog Manager tool.

Enter the product and release segments associated with the catalog.

To add a topic heading folder to the tree: a.

Click the Article context menu in the tree, then select Insert Node.

Select a topic heading folder, type the desired name above, then click Rename.

4-2

Chapter 4

Organize Articles in a Catalog

c. 4.

Click Save Catalog to save your changes.

To add an article to the tree, drag-and-drop it from the workspace on the right to the tree on the left.

If an article in the catalog has the same pub alias as the article you are adding, you are prompted on whether to replace or keep the existing article.

Click Save Catalog to save your changes.

The article status changes from Unplaced to Placed in the workspace. 5.

To remove an article from the tree, click the Article context menu in the tree or the workspace, then select Remove from Catalog. Click Save Catalog to save your changes.

4-3

Chapter 4

Change the Title of an Article Catalog

The status of removed articles changes from Placed to Unplaced in the workspace. 6.

To remove a topic heading folder and its contents from the tree, click the Article context menu in the tree, then select Remove from Catalog. Click Save Catalog to save your changes. The folder and its contents are removed from the tree. The status of removed articles changes from Placed to Unplaced in the workspace.

Change the Title of an Article Catalog You can change the title of an article catalog after it has been created. 1.

In Jarvis, select Article Catalogs from the Assign Metadata menu.

Enter the GUID of the catalog; for example, TEST-PRODUCT-GROUP-TEST-PRODUCTTEST-RELEASE, then click Validate GUID. View the catalog GUID at the catalog URL (https://docs-uat.us.oracle.com/en/<OHC base path>/catalog): for example, https://docs-uat.us.oracle.com/en/sptest/test-suite/testproduct/test-release/catalog.

Select the version (dev or prod-n) of the catalog you want to change.

Click Validate Publication to open the catalog details.

Enter the new catalog title, then click Save.

Create a Release Candidate of a Catalog When a catalog is complete and release-ready, create a release candidate of an article catalog. Use the resulting production version to build to these environments: •

Final UAT

•

Directly to Stage

4-4

Chapter 4

Make a Copy of a Catalog 1.

Open the catalog in Catalog Manager.

Click the Create a Release Candidate button. A prod-n version of the catalog is created with a Release Candidate status.

Related Topics •

Make a Copy of a Catalog You can copy a catalog for an existing product release to a new release. 1.

In Jarvis, go to the Catalog Manager tool.

Click the Catalog context menu, then select Clone Catalog.

Enter the title of the catalog you want to copy, then click Search.

Select the desired catalog and version, then click Next.

Enter the catalog information: a.

In Title, enter the catalog title.

In Description, enter information to describes the purpose or scope of the catalog. The description doesn't appear externally.

Under Metadata, select the release associated with the new catalog.

Click Create Catalog. Articles with the same product metadata that you have built to UAT appear in the Workspace.

Restore an Article Catalog to a Previous State A backup is created each time you save the catalog. Backups can be restored for any save point. To request the restoration of a backed-up catalog, contact the ua-helpdesk Slack channel. Provide this information: •

The product, release, and version of the catalog to be restored.

•

The approximate date and time of the backup to be restored.

View the Catalog GUID The catalog GUID is needed to enter the cover page for the catalog in Jarvis. The GUID can be used to search for a catalog to build in Jarvis. 1.

Go to the catalog URL (https://docs-uat.us.oracle.com/en/<OHC base path>/catalog): for example, https://docs-uat.us.oracle.com/en/sptest/test-suite/article-catalog/latest/catalog.

4-5

Chapter 4

View the Catalog GUID

Click the string in all caps to view the catalog GUID. The GUID is the alphabetic string; for example, TEST-PRODUCT-GROUP-ARTICLE-CATALOG-LATEST, and does not include the numeric timestamp at the end of the string.

Related Topics •

Change the Title of an Article Catalog You can change the title of an article catalog after it has been created.

•

Update the PDF Cover Page for Subsequent Builds If a version of the article catalog has already been built to Final UAT or directly to Stage, you can change the information on the cover and copyright pages of the PDF output in Jarvis before building the catalog again.

•

4-6

5 Building Articles and the Article Catalog Use self-publishing to build articles and the article catalog to the UAT, Stage, and Production environments. Always build articles before building the catalog. Build the catalog when its organization has been changed or to apply content filters to articles without republishing them. You can send non-Final UAT builds of the catalog to Oracle Review. You can send Final UAT builds of articles or the catalog for machine translation. All Final UAT builds of the catalog generate PDF output.

Manage the versioning and building of articles from the catalog You can view the status of article publications from the catalog to determine which articles have been versioned, which articles have been built and to which environments, and which articles still need to be built. 1.

In Jarvis, go to the Catalog Manager tool.

In the Workspace, view the publication status: •

Proposed – The article has been placed in the catalog, but not yet built.

•

Versioned – A new version of the article is available, but hasn't been built yet. A previous version of the article is in the catalog and has been built before.

•

Unplaced – The article has not been placed in the catalog.

•

UAT – The article has been built to the UAT environment.

•

STAGE – The article has been built to the Staging environment.

•

PROD – The article has been built to the Production environment.

Build Existing Articles to Non-Final UAT from Catalog Manager Quickly build multiple existsing articles—including new versions that haven't been built yet—to non-Final UAT from within an article catalog. 1.

Open the catalog in Catalog Manager.

In the tree, select the articles to build.

5-1

Chapter 5

Build Articles to Non-Final UAT 3.

Click the Build button, then select Build to UAT.

Accept the default mostly recently built version, select a new version that hasn't been built yet, or select a previous version of each article, then click Submit.

Specify the relevant build options, such as whether to skip QA testing, show draft comments, or show a pre-general availability statement in the HTML output.

Click Submit to start the build

Build Articles to Non-Final UAT in Jarvis Build articles to non-Final UAT in the same way you build other content types using selfpublishing in Jarvis. The first-time you build article publications to non-Final UAT, you must build them in Jarvis before they appear in the catalog. 1.

In Jarvis, select Build to UAT from the Build and Promote menu.

Find articles using one of these methods: •

Enter the doc ID, GUID, or title of a single article.

•

Select a search tag.

•

Select SSOT elements and content type or enter other search criteria under Advanced Search.

Select the articles to build, then click Check Pubs.

Specify the relevant build options, such as whether to skip QA testing, show draft comments, or show a pre-general availability statement in the HTML output.

Click Submit to start the build.

5-2

Chapter 5

Build a Catalog to Non-Final UAT

Build a Catalog to Non-Final UAT Build the development version of the catalog to non-Final UAT to update the catalog hierarchy or apply updated content filters to articles in the catalog. Build new and updated article publications to non-Final UAT. 1.

In Jarvis, select Build to UAT from the Build and Promote menu.

Find the catalog using one of these methods: •

Enter the title or GUID of the catalog.

•

Select a search tag.

•

Select SSOT elements and content type or enter other search criteria under Advanced Search.

Select the dev version of the catalog, then click Check Pubs.

Specify the relevant build options, such as whether to skip QA testing, show draft comments, or show a pre-general availability statement in the HTML output.

Click Submit to start the build.

Related Topics •

Send a Catalog to Oracle Review Non-Final UAT builds of the catalog can be sent to Oracle Review. Before you begin Build any new or updated article publication to non-Final UAT before sending the catalog to Oracle Review, so that the most current content is included in the review. 1.

In Jarvis, go to the Catalog Manager tool.

Find the catalog using one of these methods: •

Enter the title or GUID of the catalog.

•

Select a search tag.

•

Select SSOT elements and content type or enter other search criteria under Advanced Search.

Select the dev version of the catalog, then click Check Pubs.

Select Send HTML to Oracle Review under Article Catalog, then select a review type: •

Select Reuse Last Review when you want to send the catalog to the previous review ID. The content in the review is updated, previous reviewer notes are retained, and reviewers can continue adding notes.

•

Select Create a New Review the first time that you send a document to Oracle Review, when you want a new review for a different version of the document or for the same version of the document.

5-3

Chapter 5

Build Articles to Final UAT •

Select Use Given Review ID when you want to send the document to a specific review ID. The content in the review is updated, previous reviewer notes are retained, and reviewers can continue adding notes.

Note: To find the review ID in Oracle Review, click the Properties icon for the document. 5.

Click Submit to start the build.

Build Articles to Final UAT As the article content is completed and ready to be released, build articles to Final UAT.

Build Articles to Final UAT from Catalog Manager Quickly build multiple articles to Final UAT from within an article catalog. 1.

Open the catalog in Catalog Manager.

In the tree, select the articles to build.

Click the Build button, then select Build to UAT.

Answer Yes to Is this your final run to UAT?

To promote the articles to Stage after successfully building to final UAT, select Promote to Stage.

To only create a final UAT build, click Submit.

Build Articles to Final UAT in Jarvis Build articles to Final UAT in the same way you build other content types using self-publishing in Jarvis. 1.

In Jarvis, select Build to UAT from the Build and Promote menu.

Find articles using one of these methods: •

Enter the doc ID, GUID, or title of a single article.

•

Select a search tag.

•

Select SSOT elements and content type or enter other search criteria under Advanced Search.

Select the articles to build, then click Check Pubs.

Answer Yes to Is this your final run to UAT?

To promote the articles to Stage after successfully building to final UAT, select Promote to Stage.

To only create a final UAT build, click Submit.

Send Final Articles to Machine Translation After successfully building articles to final UAT, you can send them to machine translation.

5-4

Chapter 5

Create a Release Candidate of a Catalog

Send Final Articles to Machine Translation from Catalog Manager Quickly send articles with release-ready content to machine translation from within an article catalog. You must have the DOCENG_MT_ENABLE entitlement and the product content must have been approved by IPS team before you can use machine translation. 1.

Open the catalog in Catalog Manager.

In the tree, select the articles to build.

Click the Build button, then select Build to UAT.

Answer Yes to Is this your final run to UAT?

Select Send to MT (Machine Translation).

To promote the articles to Stage after successfully building to final UAT, select Promote to Stage.

To only create a final UAT build, click Submit.

Send Final Articles to Machine Translation in Jarvis Send articles with release-ready content to machine translation using self-publishing in Jarvis. You must have the DOCENG_MT_ENABLE entitlement and the product content must have been approved by IPS team before you can use machine translation. 1.

In Jarvis, select Build to UAT from the Build and Promote menu.

Find articles using one of these methods: •

Enter the doc ID, GUID, or title of a single article.

•

Select a search tag.

•

Select SSOT elements and content type or enter other search criteria under Advanced Search.

Select the articles to build, then click Check Pubs.

Answer Yes to Is this your final run to UAT?

Select Send to MT (Machine Translation).

To promote the articles to Stage after successfully building to final UAT, select Promote to Stage.

To only create a final UAT build, click Submit.

Final UAT

•

Directly to Stage

Open the catalog in Catalog Manager.

5-5

Chapter 5

Build a Catalog to Final UAT and Generate PDF Output 2.

Click the Create a Release Candidate button. A prod-n version of the catalog is created with a Release Candidate status.

Build a Catalog to Final UAT and Generate PDF Output Final UAT builds always generate PDF output of the article catalog. Before you begin Build any new or updated article publications to Final UAT before building the catalog to Final UAT, so that the most current content is included in the catalog.

Build a Catalog to Final UAT Final UAT builds always generate PDF output of the article catalog. 1.

In Jarvis, select Build to UAT from the Build and Promote menu.

Find the catalog using one of these methods: •

Enter the title or GUID of the catalog.

•

Select a search tag.

•

Select SSOT elements and content type or enter other search criteria under Advanced Search.

Select the appropriate production version of the catalog, then click Check Pubs.

Click Submit to start the build.

Enter the PDF Cover Page the First Time a Catalog is Built If this information hasn't already been entered, you must enter what you want to appear on the cover and copyright pages of the PDF output the first time you build an article catalog whether you are building to Final UAT or directly to Stage. 1.

After selecting the build options for the catalog, enter information for the cover and copyright pages of the PDF output: a.

Enter the full product name; for example, "Oracle Autonomous Database."

Enter the product release information, for example, "Release 23.4.1," "23.c," or leave blank.

Enter the platform information; for example, "on Dedicated Exadata Infrastructure" or leave blank.

Select the month and year that the catalog is being published.

In Copyright First Year, select the first year that the catalog was published.

In Copyright Last Year, select the current year that the catalog is being published if it differs from the first year the catalog was published.

Enter the first and last name of primary authors as needed.

Enter the first and last name of contributing authors as needed.

Enter the first and last or team name of contributors as needed.

Click Update and Continue to save your changes and start the build.

5-6

Chapter 5

Update the PDF Cover Page for Subsequent Builds

In Jarvis, select Article Catalogs from the Assign Metadata menu.

Enter the GUID of the catalog; for example, TEST-PRODUCT-GROUP-ARTICLECATALOG-LATEST, then click Validate GUID.

Select the version (dev or prod-n) of the catalog you want to change.

Click Validate Publication to open the catalog details.

Enter information for the cover and copyright pages of the PDF output: a.

Enter the full product name; for example, "Oracle Autonomous Database."

Enter the product release information, for example, "Release 23.4.1," "23.c," or leave blank.

Enter the platform information; for example, "on Dedicated Exadata Infrastructure" or leave blank.

Select the month and year that the catalog is being published.

In Copyright First Year, select the first year that the catalog was published.

In Copyright Last Year, select the current year that the catalog is being published if it differs from the first year the catalog was published.

Enter the first and last name of primary authors as needed.

Enter the first and last name of contributing authors as needed.

Enter the first and last or team name of contributors as needed.

Send the Final Catalog to Machine Translation After successfully sending the article catalog to final UAT, you can send them to machine translation. Send the final articles to machine translation. 1.

In Jarvis, select Build to UAT from the Build and Promote menu.

Find the catalog using one of these methods: •

Enter the title or GUID of the catalog.

•

Select a search tag.

•

Select SSOT elements and content type or enter other search criteria under Advanced Search.

Select the appropriate production version of the catalog, then click Check Pubs.

Answer Yes to Is this your final run to UAT?

Select Send to MT (Machine Translation).

To promote the catalog to Stage after successfully building to final UAT, select Promote to Stage.

To only create a final UAT build, click Submit.

5-7

Chapter 5

Promote Articles from Final UAT to Stage

Promote Articles from Final UAT to Stage Promote articles that have been built to final UAT to the Stage environment when needed. 1.

In Jarvis, select Promote from UAT to Stage from the Build and Promote menu

Find articles using one of these methods: •

Enter the doc ID, GUID, or title of a single article.

•

Select a search tag.

•

Select SSOT elements and content type or enter other search criteria under Advanced Search.

Select the articles to build, then click Check Pubs.

Click Submit to start the build.

Promote a Catalog from Final UAT to Stage Promote an article catalog that has been built to final UAT to the Stage environment when needed. Before you begin Promote any new or updated article publication to Stage before promoting the article catalog to Stage. 1.

In Jarvis, select Promote from UAT to Stage from the Build and Promote menu

Find a catalog using one of these methods: •

Enter the title or GUID of the catalog.

•

Select a search tag.

•

Select SSOT elements and content type or enter other search criteria under Advanced Search.

Select the appropriate production version of the catalog, then click Check Pubs.

Click Submit to start the build.

Build Articles Directly to Stage For small changes that don't require a technical review, you can skip UAT and build articles directly to Stage.

Note: In the initial release, machine translation is not supported when building directly to Stage. 1.

In Jarvis, select Build Directly to Stage from the Build and Promote menu.

Find articles using one of these methods: •

Enter the doc ID, GUID, or title of a single article.

5-8

Chapter 5

Create a Release Candidate of a Catalog •

Select a search tag.

•

Select SSOT elements and content type or enter other search criteria under Advanced Search.

Select the articles to build, then click Check Pubs.

If the articles need to be machine translated, select Send to Machine Translation (MT).

Note: You must have the DOCENG_MT_ENABLE entitlement and the product content must have been approved by IPS team before you can use machine translation. 5.

If delivering content for a beta release, select Show beta statement for pre-general availability, then select Private or Public.

Click Submit to start the build.

Related Topics •

Final UAT

•

Directly to Stage

Open the catalog in Catalog Manager.

Click the Create a Release Candidate button. A prod-n version of the catalog is created with a Release Candidate status.

Build a Catalog Directly to Stage and Generate PDF Output Building directly to Stage always generate PDF output of the article catalog. Before you begin Build any new or updated article publications to Stage before building the catalog directly to Stage, so that the most current content is included in the catalog. Related Topics •

5-9

Chapter 5

Update the PDF Cover Page for Subsequent Builds

Build a Catalog Directly to Stage Build an article catalog directly to Stage without building it to UAT first. Before you begin Promote or build any new or updated article publication to Stage before building the article catalog to Stage. 1.

In Jarvis, select Build Directly to Stage from the Build and Promote menu

Find a catalog using one of these methods: •

Enter the title or GUID of the catalog.

•

Select a search tag.

•

Select SSOT elements and content type or enter other search criteria under Advanced Search.

Select the appropriate production version of the catalog, then click Check Pubs.

Click Submit to start the build.

After selecting the build options for the catalog, enter information for the cover and copyright pages of the PDF output: a.

Enter the full product name; for example, "Oracle Autonomous Database."

Enter the product release information, for example, "Release 23.4.1," "23.c," or leave blank.

Enter the platform information; for example, "on Dedicated Exadata Infrastructure" or leave blank.

Select the month and year that the catalog is being published.

In Copyright First Year, select the first year that the catalog was published.

In Copyright Last Year, select the current year that the catalog is being published if it differs from the first year the catalog was published.

Enter the first and last name of primary authors as needed.

Enter the first and last name of contributing authors as needed.

Enter the first and last or team name of contributors as needed.

Click Update and Continue to save your changes and start the build.

In Jarvis, select Article Catalogs from the Assign Metadata menu.

5-10

Chapter 5

Promote Articles from Stage to Production 2.

Enter the GUID of the catalog; for example, TEST-PRODUCT-GROUP-ARTICLECATALOG-LATEST, then click Validate GUID.

Select the version (dev or prod-n) of the catalog you want to change.

Click Validate Publication to open the catalog details.

Enter information for the cover and copyright pages of the PDF output: a.

Enter the full product name; for example, "Oracle Autonomous Database."

Enter the product release information, for example, "Release 23.4.1," "23.c," or leave blank.

Enter the platform information; for example, "on Dedicated Exadata Infrastructure" or leave blank.

Select the month and year that the catalog is being published.

In Copyright First Year, select the first year that the catalog was published.

In Copyright Last Year, select the current year that the catalog is being published if it differs from the first year the catalog was published.

Enter the first and last name of primary authors as needed.

Enter the first and last name of contributing authors as needed.

Enter the first and last or team name of contributors as needed.

Promote Articles from Stage to Production Promote articles that have been built to Stage to the Production environment when needed. 1.

In Jarvis, select Promote from Stage to Production from the Build and Promote menu

Find articles using one of these methods: •

Enter the doc ID, GUID, or title of a single article.

•

Select a search tag.

•

Select SSOT elements and content type or enter other search criteria under Advanced Search.

Select the articles to build, then click Check Pubs.

Click Submit to start the build.

Promote a Catalog from Stage to Production Promote an article catalog that has been built to Stage to the Production environment when needed. Before you begin Promote any new or updated article publication to Production before promoting the article catalog to Production. 1.

In Jarvis, select Promote from Stage to Production from the Build and Promote menu

Find a catalog using one of these methods: •

Enter the title or GUID of the catalog.

•

Select a search tag.

5-11

Chapter 5

Promote a Catalog from Stage to Production •

Select SSOT elements and content type or enter other search criteria under Advanced Search.

Select the appropriate production version of the catalog, then click Check Pubs.

Click Submit to start the build.

5-12