Optics for Data Center

Optics for Data Center

This DC version of Optics - Content Formatting has been specially developed based on feedback and requests from our valued data center customers. While it may not include all the features available in the Cloud version, we've incorporated the most used cloud features to ensure a seamless and efficient experience for our data center users.


Cards

image-20240418-143115.png

Inline editing

Use an inline editing feature and seamlessly edit the content of your cards. Write your cards copy directly on-screen and make quick changes with one click. There is no character limit.

Icon

Click on icon and choose from more than 5000 icons available and attract even more attention with Atlassian built-in emojis. To change the icon position or remove label, use the “Icon” dropdown in the macro configuration.

Color

Choose a theme color from the Atlassian primary and secondary colour palette. If you want to add more colours, use the HEX editor.

Card Link

Add links to Confluence content (pages and attachments) and external URLs, giving them a more polished look. Use the email tab to open the mail client with the click on the button.

Elements

Use the Layout structure option to enable/disable overline, title, line and text. By default, all elements are enabled.

Design styles

The design style feature allows you to explore and play with different design styles until you find one perfect for your use case. Also, you get to select which elements you want to include and visually present in your cards.


Button

image-20240418-143210.png

 

Add label here

Use an inline editing feature and seamlessly edit the content of your button. Write your button copy directly on-screen and make quick changes with one click. The character limit is 40.

Icon/Emoji

Click on icon and choose from more than 5000 icons available and attract even more attention with Atlassian built-in emojis. To change the icon position or remove label, use the “Icon” dropdown in the macro configuration.

Button Width

Use the slider to change the button width. It will add space inside the button.

Button Radius

Use the slider to round the edges of your button.

Shadow

Activate shadow with selecting one of the four predefined shadow styles: No shadow, outer shadow, and drop shadow.

Color

Choose a fill, border, text, and icon colors from the Atlassian primary and secondary color palette. Choose a fill, border, text, and icon hover colors. If you want to add more colors, use the HEX editor.

Button Link

Add links to Confluence content (pages and attachments) and external URLs, giving them a more polished look. Use the email tab to open the mail client with the click on the button.


Panel

image-20240418-143244.png

Type

The panel type setting is used to define the type of panel; Standard, Notification, or Atlassian style.

Design style

Panel design style settings refer to the overall look and feel of a panel. These setting includes; Info, Note, Error, Warning, Success, and Custom design styles. All of these elements work together to create a cohesive design style for the panel.

Elements

The Elements setting allows you to add or remove elements from a Panel. Elements consist of Icon and Title.

Panel title and icon are edited inline, while the content is edited on the Confluence page once clicked on the Save button.

Icon and Title size

The size of the icon and title in the Panel can be changed using the slider.

Title Alignment

Title alignment can be set using the Title Alignment option. There are three different title alignment options, including Left, Center, and Right.

Body Alignment

Body alignment can be set using the Body Alignment option. There are three different body alignment options, including Left, Center, and Right.


Cloud Migration

Prerequisites

Data Center Requirements

  • Confluence Data Center 7.x or later

  • Optics for Confluence (Data Center) installed and licensed

  • Cloud Migration Assistant (CCMA) plugin installed

  • Administrator access to the Confluence instance

  • Latest version of Optics for DC (1.0.17 or later) and Cloud (-version number TBD-)

Cloud Requirements

  • Confluence Cloud instance with Optics installed from the Atlassian Marketplace

  • Site administrator access

Migration Steps

Step 1: Prepare Your Data Center Instance

  1. Ensure the Optics plugin is up to date on your Data Center instance.

  2. Verify that the Cloud Migration Assistant is installed and accessible at Administration > Cloud Migration Assistant.

Step 2: Prepare Your Cloud Instance

  1. Install Optics from the Atlassian Marketplace on your Cloud instance.

  2. Ensure you have site administrator permissions.

Step 3: Run the Migration

  1. In your Data Center instance, navigate to Administration > Cloud Migration Assistant.

  2. Click Assess your apps to check app migration compatibility.

  3. Optics should appear with a status indicating that it supports automated migration.

  4. Create a new migration plan or use an existing one.

  5. Select the spaces you want to migrate.

  6. In the Apps step, ensure Optics is selected for migration.

  7. Review and run the migration.

Note

The migration process handles page content automatically. Optics processes each migrated page to identify Button and Cards macros that contain page links, then creates mappings to ensure these links work correctly in Cloud.

Step 4: Verify the Migration

After the migration completes:

  1. Navigate to migrated pages containing Optics macros in your Cloud instance.

  2. Verify that Button macros render correctly and navigation works.

  3. Verify that Cards macros display properly and card links navigate to the correct pages.

What Gets Migrated

The following Optics macro types are supported:

Macro

Migration Support

Notes

Macro

Migration Support

Notes

Button

✅

Page links are automatically resolved to Cloud page IDs.

Cards

✅

All card configurations and page links are migrated.

Panel

✅

Panel configuration is migrated. Panels don't contain page links.

Page Link Resolution

During migration, Optics:

  1. Scans each migrated page for Button and Cards macros.

  2. Extracts page IDs referenced in macro links.

  3. Maps Data Center page IDs to their corresponding Cloud page IDs.

  4. Stores these mappings as content properties on each page.

When you view a migrated page in Cloud, Optics automatically resolves the original Data Center page links to their new Cloud locations.

Troubleshooting

Macros Not Rendering

Macro appears blank or shows an error

  • Ensure Optics is installed and licensed on your Cloud instance.

  • Try refreshing the page.

  • Check that the page was included in the migration and was not skipped because of errors.

Page Links Not Working

Clicking a button or card navigates to the wrong page or shows an error

  • The linked page may not have been included in the migration.

  • If the target page exists in a different space, ensure that space was also migrated.

  • Re-running the migration for the affected spaces may resolve mapping issues.

Migration Shows Warnings

CCMA reports warnings during Optics migration

Some warnings are expected and do not indicate a problem:

  • Page not found warnings: These may occur if macros reference pages that were deleted or were not included in the migration scope.

  • Mapping warnings: These may occur for pages in spaces outside the migration scope.

These warnings are logged but do not prevent the migration from completing. Affected macros will fall back to their original link behavior.

Support

If you encounter issues during migration:

  1. Check the CCMA migration logs for detailed error information.

  2. Review the Optics documentation for known issues.

  3. Contact support with your migration logs and details about the affected pages.