Playbook Widget Usage

Kirby R
Kilo Sage

Sharing here some details on how to embed playbooks in portal. This is just a simple use case and hopefully can help and guide anyone who's interested in similar or complex use case. Also note that this is just an iframe rendering ui builder, so customizing it might need UI builder knowledge.

 

Version: Xanadu(Most likely this will work on later versions as well)

 

A working playbook in portal should have a URL similar to this:

https://xxxxxx.service-now.com/esc?id=playbook&table=sn_risk_advanced_risk_identification&sys_id=662...

 

Let try to identify the url parameters:

 

  • id - this is the oob sp_page that has the playbook widget instance.
  • table - from the sample URL, i have risk identification as my use case. you can replace this with your own table
  • sys_id - this is the sys_id of the record from table
  • query - this is string containing "recordGeneratorId%3D" + sys_id for record generator
  • playbookExperienceId - playbook experience sys_id

 

Based on the details above, we are missing query and playbookExpereinceId. 

To get the record generator id, we need to create a Playbook Record Generator

 

Steps:

1. Navigate to playbook record generator.

KirbyR_0-1751535202042.png

KirbyR_1-1751535304586.png

Playbook record generator - Official documentation

 

Now we have the playbook record generator id, lets get the experience. 

Steps:

1. 

KirbyR_2-1751536306473.png

2. From sample URL, I have used OOB risk identification so ill get its sys_id. If you have your own custom, you can use that.

 

Now putting them all together, you can now render the playbook in portal.

KirbyR_3-1751536550462.png

 

Any questions or feedback you may leave in the comments.

 

 

 

 

 

 

 

3 REPLIES 3

Hanna_G
Tera Guru

This is really cool thanks @Kirby R 

Do you know if it is possible to make the iframe height dynamic based on the playbook content, or do we need to manually set a fixed height?

Hi @Hanna_G , you can dynamically adjust the height but based on playbook content, i believe no or at least i haven't figured out yet.

 

The oob playbook widget accepts height as option.

KirbyR_0-1751541803797.png

 

Hope this helps.

 

Nice one, thank you @Kirby R!