Custom component in Ribbon

Tommy Jensen
Giga Guru

Have anybody been able to use a custom component as a Ribbon component?

I deployed my simple component. It only displays a text.

Then I added ACL's on the table: sys_aw_ribbon_component

and created a record there that points to my component.

Then in "Ribbon settings" I configured it to display on my record in workspace.

When a record with this Ribbon is displayed. I can see that space has been assigned to the component and inspecting the page I can actually see the component directive but the content is not rendered. And there is no errors at all in the console.log.

So what could I be missing?

find_real_file.png

running locally this is what it displays:
find_real_file.png

 

This is the component, super simple:

import { createCustomElement, actionTypes } from '@servicenow/ui-core';
import snabbdom, { Fragment } from '@servicenow/ui-renderer-snabbdom';
import styles from './styles.scss';

import '@servicenow/now-heading';

const view = (state, { dispatch, updateState }) => {
	return (
		<Fragment>
			<main className="now-checklist">
				<div>
					<now-heading label="Test ribbon" />
				</div>
			</main>
		</Fragment>
	);
};

createCustomElement('x-80603-my-ribbon', {
	renderer: { type: snabbdom },
	view,
	styles: styles
});
25 REPLIES 25

My PDI is on patch 1. I will test it on my patch 3 instanse.

Unfortunately that did not change anything 😞 Still not working.

These are the instructions I got for Orlando Patch 3+, I have not tried them yet.

Ribbon

Component Configuration

  • Instance Version: Orlando Patch 3+
  • Role Required: admin
  • Steps:
    1. Create a new Ribbon Component
      • In the platform navigator, type in sys_aw_ribbon_component.do and hit enter
      • On the Ribbon Component form, enter the following:
        • Name: [Any name]
        • UX Component: [select your component]
        • Description: [Any description]
      • Click Submit to create the new record
    2. Create a new Ribbon Settings Component
      • Using the platform navigator, go to “Workspace Experience > Forms > Ribbon Settings”
      • Click “New” to create a new Ribbon Settings record
      • On the Ribbon settings record, enter the following
        • Name: [Any name]
        • Ribbon Component: (created in Step 1)
        • Table: [Table you want this to show up on]
        • Width: [Column width. Values can be 1-12]
        • Workspace: Agent Workspace
        • Order: [The display order from left to right]
        • Active: true
      • Click Submit to create the new record

 

That is exactly what I did.

 

However I see you say ptach 3+. My instanse is only at 3. So I just logged on to HI to upgrade and see a patch 4 available. Crossing fingers that this patch solves all my current issues.

Just finished the upgrade to patch 4. No change 😞 Let me know if you can get it to work.