Skip to Content
Product Information
Author's profile photo Rinky Karthik

Health and Vaccine Status Tracking Block/Portlet in SuccessFactors People Profile

The COVID pandemic has changed the shape of the workplace. In 2020, most employees were asked to work from home, and instant transformations by employers were required to make it effective.

While in 2020, organizations were reactive to the pandemic situation and focused on new ways to manage the remote workforce. In 2021 organizations are proactive and planning to safely bring the workforce back to an office setting. With Vaccination playing a key role, many companies are strategizing plans for safe return to the workplace based on employee’s current health and vaccine status.

Just as technology was key to a successful work-from-home transition, it is also essential when employees step foot into their workplaces again. SAP introduced a new service offering named the Back-to-Work package in Q4 2020 to support an effective workplace return. This offering uses SAP SuccessFactors solutions combined with Experience Management solutions from SAP and Qualtrics, SAP Analytics Cloud, and SAP Fieldglass.

The offering was released during SuccessConnect2020. Read more about this offering and the press release from Oct 2020: Create and Manage a Resilient Workforce.

SAP’s Back-to-Work offering


Fig 1:SAP Disruption response services for HR

One of the key components of the offering is Return: Bringing back your workforce safely. Many organizations are figuring out ways to track employees’ Health and Vaccination Status to manage the effective workplace return strategy.

At SAP, we have been working on a solution Health and Vaccine Portlet and where legislation and local data protection rules permit, companies will be able to add new health and vaccination status fields to the People Profile in the SAP SuccessFactors Employee Central solution, allowing employees to enter employee vaccine information.

This blog will walk through this Health and Vaccine Portlet’s details and how SAP Customers and Partners can leverage this Free solution.

The Health and Vaccine Portlet will be available as part of the 1H 2021 Release as an Opt-In item in the Upgrade Center, and there is no additional cost for our existing customers to deploy this solution.

You can read more about SAP’s response to the pandemic here: Business Challenges and Opportunities Post-COVID-19| SAP News Center


Please note that SAP is not in a position to provide any legal advice but rather provides functionality and configuration options within its products that allow you to configure your environment in a way that should meet your legal team’s definition of compliance concerning local and regional legislation.


The Health and Vaccination Tracking portlet leverages the SuccessFactors MDF framework to provide SuccessFactors customers with a template to manage their workforce during the pandemic. This solution offers the ability to:

  • Monitor and track employee’s Health and Vaccine status
  • Produce analytics to identify & support high-risk employees based on location, business unit, department age, work area, etc.

About the Solution

This solution is built with SuccessFactors Metadata Framework (MDF) by leveraging custom MDF objects, Role-Based Permission (RBP), and Report Story. Any SAP SuccessFactors EC customers can take advantage of this solution.

This is not a new product within the SuccessFactors HXM suite, nor a new SAP SuccessFactors service offering but an accessible and free Upgrade Center Opt-In item for all customers. We have built this Portlet as a custom MDF Objects to showcase SuccessFactors flexibility as a Solution so that our customers can leverage the customization capability in the product to track vaccination status.


Employee Central and Role-Based Permissions must be enabled and implemented to leverage this solution. IAS (Identity Authentication Service) is a pre-requisite for Report Story.

How to enable the Health and Vaccine Portlet

This solution is free of cost to our existing SuccessFactors customers, except for any services engagement to customize the portlet.

The Upgrade Center item ‘Health & Vaccine Tracking,’ when Opt-In, will download all delivered COVID Health and Vaccine Portlet components into your Instance. You can follow the Role-Based Permission Steps to manage access to this Portlet.

The upgrade center item comes with pre-delivered content; however, it may not satisfy every customer’s requirements related to Vaccine tracking, but it provides a solid template based on industry use cases.

We have also included a How-to-Guide for customizing Health & Vaccine Portlet if the customer wishes to further customize the delivered COVID Health and Vaccine Status Portlet. Customers can follow this guide to add/modify/remove any fields, picklists, or tabs. Please follow this guide to customize as per your specific requirement.

We suggest working with the SAP Professional Services team or an SAP Partner to customize the COVID Portlet . You can also create a ticket in the Best Practices component LOD-SF-SBP, and the support team will help you enable the Provisioning switch for ‘SAP Best Practices’, if its not already enabled.

Once its enabled, if the customer has a technical HRIS team, the portlet can be downloaded and customized by following the How-to-Guide. The ‘Steps to Create Story’ guide will help you to build a new Report Story.

As with any new Opt-in functionality, we recommend deploying in a test instance before deploying in production.

You will see the ‘Health and Vaccine Tracking’ solution under Optional Upgrades. Please filter by SAP Best Practices to locate it easily.


Fig 2: Upgrade Center

Health and Vaccine Portlet in People Profile

The Health and Vaccine Status Portlet is available in People Profile and permission with Role-Based Permission Framework (RBP). There are two tabs to capture and store Health and Vaccine Status separately, as shown in Fig 2. Both these tabs are effective dated and store history.

Note: Always refresh the UI Rules in Manage Config UI, once you complete the Upgrade.


Fig 3: Health and Vaccine Portlet

1. Health Status Tracking

The Health Status tab provides a series of questions to the Employee. Most of these questions are derived from the common questions that the Health Authorities Worldwide (e.g., WHO or CDC for the USA) suggest asking visitors or workers.

  • These questions are logically sequenced, and based on a Yes/No response, the next set of relevant questions will be posed to the Employee.
  • The information is effectively dated and will store history.
  • This section is completely customizable, i.e., customers can hide any delivered question, change the sequence or add new questions as relevant to their business processes.

The ‘Current Health Status’ is an important field in this portlet, and reports can be created with this field as a key value.

2. Vaccine Status Tracking

The Vaccine Status tab also provides a series of questions to get the vaccination status from the employee.

  • The Vaccine Status Portlet is designed to track the current Vaccine status of an employee.
  • This portlet is also effective dated.
  • There are 4 Vaccine Status configured :
    • Fully Vaccinated (both doses are complete and dates are in the past)
    • Vaccinated 1st dose only (1st dose is complete only, 2nd dose is a future date)
    • Planned (Appointments are taken or intend to take the vaccine but waiting to schedule an appointment)
    • Declined (Declined to take vaccine)

Notification and Workflow can be configured to remind the employees about upcoming appointments or to complete the portlet.

Here’s the decision matrix with USA vaccine examples to explain the Vaccination Status field. The ‘Authorized Vaccine’ field’s dropdown values can be updated based on country-specific authorized vaccines.


Fig 4: Vaccine Status Tracking Portlet Decision Matrix


Report Story on Health & Vaccine Portlet

Report Story built with data entered in the Health & Vaccine Portlet, combined with Employee Central data, provides Employers practical real-time analytics to safely bring back the workforce to the office and approve employee travel. The Report Story dashboard provides actionable data to identify frontline employees in need of Vaccination, % vaccinated based on Department, Division, Cost Center, etc.

Here’s an example of a couple of Report Story we have built.


Fig 5: Story on Vaccine Status Portlet

This Vaccine Status portlet shows Vaccination Status based on foundation structure (i.e., department, division, location, etc.).It also provides projected completion based on scheduled appointment dates and the overall employee population.


Fig 6: Story on Health Status Portlet

Similarly, the Story built on the Health Status portlet provides employees’ current health status-related Risk assessment based on employee’s working condition, i.e., remote worker vs. planning to go back to office location.

We have provided a detailed Report Story guide with the Upgrade Center opt-in item. Please download the guide to learn the steps to build a Story from scratch. IAS is a prerequisite to use Report Story.

Custom Tiles in SuccessFactors Home Page

You can also create a new section within the Home Page and add custom tiles to provide information related to Organization’s back to work-related details, local/federal vaccine, travel information, or other work facilities-specific information. Here are some ideas to built these Tiles :

  • Links to Local, State, or Federal Government health sites. E.g., For the US, we have provided links to CDC in this prototype.
  • Link to Vaccine Tracker: consuming the CDC data to provide the employees easy access to find vaccination sites based on their address zip-code
  • Other information, e.g., JAM pages: Customers can provide company-specific information related to COVID protocols or other internal collaboration sites.
  • These Tiles can be customized as per organization & location (different countries)need.
  • A deep-link to take employees directly to People Profile to update Health and Vaccine status. In Fig 6, you can see we have built a tile called ‘My Vaccine Status.’



Fig 7: COVID Home Page Tiles

Few other Design Considerations

The Health & Vaccine Portlet is a custom MDF object and fully customizable. Customers can expand the Health & Vaccine portlet for organization-specific scenarios. However, there are few a design considerations we would like to suggest:

Data Protection & Privacy considerations:

This portlet’s pre-delivered design captures limited vaccine-related data like First/Second Dose date, health status, etc., that are recommended by health authorities across the Globe to ask visitors/employees before entering an enclosed facility or before traveling. There is no PII (Personal Identifiable Information) data in the Portlet.

However, every Organization and Country has different Data Protection & Privacy, and Compliance measures. Therefore, we recommend the customers review the solution with their Legal/Compliance department before implementing it.

    • For example, In the USA, the Vaccine Card provided by CDC has Date of Birth information. If you plan to ask employees to attach a copy of this Vaccine card in the Vaccine Portlet, there is no way to mask only the DOB field in an attachment. More so, in the US, the  Americans with Disabilities Act clearly prohibits medical and Core HR data’s co-mingling.

RBP access for the Portlet:

With SuccessFactors Role Based Permission (RBP), limit access to this data, and portlet to authorized company personnel like HRBP or HR Admins.

Extension Center

The pre-delivered COVID Portlet has been created with the MDF approach. We have also provided another solution design option, i.e., via Extension Center in this how-to guide. Customers can work with Partners or SAP Services team to build a similar solution using Extension Center.

Business or UI Rule for Vaccination Status field:

A UI Rule has been created to auto-populate the Vaccination Status field with the following Logic. You can also do it via a Business Rule or add more Status to this existing logic.

  • If the field ‘Have you been Vaccinated yet’ = No and Have you taken an app. For Vaccination = Declining Vaccine, then the Vaccination Status = Declined.
  • If the field ‘Have you been Vaccinated yet’ = Yes and a ‘Blank’ value in Second dosage Vaccination Date, then the Vaccination Status =  Vaccinated only first Dose.
  • If the field ‘Have you been Vaccinated yet’ = Yes and both First Dosage date and second dosage date has a value, then the Vaccination Status = Fully Vaccinated.
  • If the field ‘Have you been Vaccinated yet’ = No and Have you taken an appointment for Vaccination = Waiting for available dates, then the Vaccination Status = Planned.
  • If the field ‘Have you been Vaccinated yet’ = No and Have you taken an appointment for Vaccination = Yes, then the Vaccination Status = Planned

You can find more information about these Business Rules and other configuration settings in the “How-to-Guide’.

With the onset of the COVID-19 pandemic and subsequent Vaccine availability, employers have felt the need to track Health and Vaccine status as a critical measure for bringing employees back to the office and planning for work-related travel. We hope this solution will help our customers in this regard.

Thanks to my team Mark Baker, Jaya Krishna Palakusi, Erin Roberts, and Sarah Wegiel, who helped design, build the portlet and create analytics. It’s been a busy few weeks, but I am glad we could complete it in time for 1H Release.


Update Apr 20, 2021: I have received many questions that the Opt-In is not visible in Upgrade Center. It could mean that ‘SAP Best Practices’ is not enabled in Upgrade Center. If you don’t see that feature, please enable it in Provisioning :


SAP Best Practices switch in Provisioning


Update Sep 23, 2021 – Report Story

Employee Central customers can create Report Story or Advance Analytics by combining other Employee and Organization data stored with EC with the COVID portlet data. The Upgrade Center item doesn’t come with Report Story. Every customer instance is unique based on the configuration and processes, its challenging to provide a Report Story that will work for all.

Please refer to the Stories in People Analytics section in SAP Help Portal to learn about Report Stories and how to build one. The Configuring Custom MDF Objects for Reportability Using Story Reports – SAP Help Portal explains the steps to report on custom MDF objects that aren’t reportable using other reporting tools in SAP SuccessFactors HXM Suite.

We further suggest referring to the IDP IDP – SAP SuccessFactors People Analytics Report Story Design & Implementation Considerations V1.0.pdf  to learn how to build Report Story.

Customers can work with Partners or SAP Professional Services if they need additional help in creating a Report story.

Oct 25,2021 – New Features for the EC Health & Vaccine Portlet

Oct 13,2021 Related Blog:

Oct 25, 2021 Related Blog:Collecting Vaccine Data from Onboardee with SAP SuccessFactors Onboarding


Assigned Tags

      You must be Logged on to comment or reply to a post.
      Author's profile photo Rinky Karthik
      Rinky Karthik
      Blog Post Author

      The portlet will be available in Preview Upgrade Center Apr-16-2021.

      Author's profile photo Mohan Varghese
      Mohan Varghese

      Very insightful enhancement !!!

      Author's profile photo Malgorzata Renz
      Malgorzata Renz

      Thank you Rinky for this article. Is it part of the 1H Release? I don't see it in the What's New Viewer.

      Thank you!

      Author's profile photo Rinky Karthik
      Rinky Karthik
      Blog Post Author

      Hi Malgorzata,

      Yes, its part of the 1H release. Its not in WNV yet because its not a new product offering but a template for our customers to leverage SuccessFactors and customize vaccine tracking. However, we are working to include it in WNV for better visibility. It may take a few days.



      Author's profile photo Kelvin Bauermann
      Kelvin Bauermann

      Hi Rinky Karthik , it has been two months and I still don't see it in the WNV. Do you have an update? Thanks!!

      Author's profile photo Rinky Karthik
      Rinky Karthik
      Blog Post Author

      Kelvin Bauermann

      My apologies for the late update. It was decided not to include it in WNV since its not a HXM suite Product offering but a custom MDF object, and a base configuration set to help our customer track vaccine and health status. Customers are encouraged to customize the portlet as needed.

      Author's profile photo Alvin Yan
      Alvin Yan

      Hello, great article, but I am not able to find it in Preview upgrade center.  Any idea why?

      Author's profile photo Rinky Karthik
      Rinky Karthik
      Blog Post Author

      It's already in Preview. You may have to switch on 'SAP Best Practices' to download the opt-in.

      Author's profile photo Barket Ali Zafar
      Barket Ali Zafar

      Nice Article Rinky Karthik Appreciated.

      Author's profile photo Sampath Reddy Anumasu
      Sampath Reddy Anumasu

      Thank you Rinky for detailed article appreciate your efforts, Any tentative timelines on this to see in preview?

      Author's profile photo Rinky Karthik
      Rinky Karthik
      Blog Post Author

      It's already in Preview. You may have to switch on 'SAP Best Practices' to download the opt-in.

      Author's profile photo Sampath Reddy Anumasu
      Sampath Reddy Anumasu

      Thank you Rinky.

      Author's profile photo Rinky Karthik
      Rinky Karthik
      Blog Post Author

      Enable SAP Best Practices

      Author's profile photo Aadil Bashir Bhat
      Aadil Bashir Bhat

      Hello Rinky,


      Nice and a detailed blog and at the same time a very useful feature.


      I tried to switch it on via upgrade center, however, we are receiving an error :



      The role SF ROLE for VACCINE TRACKING Portlet has been granted successfully , Exception Occured while executing the class, BestPracticesRegisterUpgrade , Exception:BPMsg: Unable to save upgradeItemStatus to the records

      java.sql.SQLException: IJ031070: Transaction cannot proceed: STATUS_MARKED_ROLLBACK, Exception while executing the steps as per upgrade config file,  ------Performing Clean Up------- , Result is false before reading config file, Stopping process,  Execution time for upgrade in seconds :88, Upgrade Failed; All changes will rollback.




      Did anyone else face the same issue, As far as I know we will not be able to log a ticket for the sales Demo?


      Any help would be appreciated.




      Author's profile photo Rinky Karthik
      Rinky Karthik
      Blog Post Author

      Hi Adil,

      If you are trying it in a cloned free Sales Demo instance, there is a chance it might fail with the role assignment error for a BP item. It shouldn't this issue with Customer preview instances or new empty sales demo instances. We have provided the how-to-guide, and you may want to add it manually following the steps.



      Author's profile photo Prasad Sistla
      Prasad Sistla

      Great feature!! Awesome Jaya.

      One thing to learn & carry forward as this solution is adapted, is,

      How do you the drive data collection enterprise wide and close it quick time?

      I know that people are generally reluctant to complete a survey or a form... especially if they are doing it twice, once for the vaccine, and secondly reporting the same in company.

      There are usually SMS campaigns ( like we see in CRM or Sales force ) in other industries to quickly collect such data points from customers.

      or you can think of creating a mail extension/adapter that can enable reading the vaccine schedule when appointment is made by the user. e.g. you see your flight schedule on calendar automatically, when you get email confirmation about a booking. Probably future IoT solution will eliminate this gap.

      Author's profile photo Diana Hromin
      Diana Hromin


      Where can we access the Guide mentioned in this blog?

      Author's profile photo Rinky Karthik
      Rinky Karthik
      Blog Post Author

      When you download the Upgrade Center item, you will see the attachment. I have also attached it to my blog in the Customer Community :



      Author's profile photo Khaled Fadhl Al-Naqeeb
      Khaled Fadhl Al-Naqeeb

      Nice feature coming at the right time.  Thanks

      Author's profile photo Benedikt Lange
      Benedikt Lange

      We recently activated the feature for parts of the organization. Much appreciated!

      I´d like to provide some comments of what needed to be adjusted so it works properly (from my point of view). I can only advise to test everything before launching:

      • Add 2 add. status: Waiting (it´s different than Planned), Recovered (no need to vaccinate due to recent infection)
      • Rules in Manage Configuration UI should not be used to default values ( I removed those parts of the rules and replaced them with regular business rules to automatically set the status
      • Notifications about length of intervals we disabled because they are different per country.
      • Added additional vaccines
      • Rule to prevent future vacination dates should not apply if the effective date is in the future. I added this to the IF statement.
      • Added additional rule to prevent from entering appointment dates  which are in the past (users could be confused with difference of appointment and vaccination date otherwise)
      • Added rule to hide all fields except "Have you been vaccinated at least once (Yes/No)" when opening for first time. Based on answer, the matching fields are displayed.
      Author's profile photo Rinky Karthik
      Rinky Karthik
      Blog Post Author

      Hi Benedikt Lange ,


      Thank you for your feedback and glad it helped. The Portlet (as I have noted in my blog earlier), may not satisfy 100% requirements for all customers. We understand the Health and Vaccine tracking need may differ for every customer based on the type of business, country, or corporate rules. We have tried to provide a prototype, that will give a base and the 'How to Guide' will help customers to tweak it as per need i.e. add rule, hide/add fields or change labels, add workflow etc.

      It's good to know the additional BRs you have created, and thank you for sharing with the community.


      Author's profile photo Abhishek Kaushik
      Abhishek Kaushik

      Thanks, Rinky.

      This is very insightful.

      Do you have a document related to Back-to-Work(Office) 

      I can't find it.


      Many thanks.


      Author's profile photo Rinky Karthik
      Rinky Karthik
      Blog Post Author

      Hi Abhishek,

      I don't. That's a separate service offering from SAP.

      Author's profile photo Matt Preece
      Matt Preece


      Is there a similar offering for non-EC instances?



      Author's profile photo Rinky Karthik
      Rinky Karthik
      Blog Post Author

      Hi Matt,


      There isn't. Technically EC is not required for custom MDF objects, but from an Use case stand point, we don't suggest storing Health and Vaccine data in a Talent only application (i.e. if EC is not enabled the customer is using SF only for Talent modules, and have a separated solution for HRIS)

      Author's profile photo Santosh Bhatge
      Santosh Bhatge

      Hi Rinky,

      Do you have any blogs to understand the different solution for HRIS ? for Covid-19 Health & Vaccine Status tracking ?

      Author's profile photo Kristine Ilowa
      Kristine Ilowa

      Hi Rinky,


      Thanks for this detailed article.

      My client is planning to enable this in DEV/TEST. They asked why is there a need to switch it off on dev/test? If they are happy with the testing how do they launch this in PRD?

      Is this part of the 1H 2021 Release? I tried to find it in the WNV but it's not there.

      I may have missed it on the blog but it does not say anything about the deployment in PRD.



      Author's profile photo Rinky Karthik
      Rinky Karthik
      Blog Post Author

      Kristine Ilowa ,

      Hi Kirstine, does that answer your question?

      Author's profile photo Rinky Karthik
      Rinky Karthik
      Blog Post Author

      Hi Kristine,

      Thank you! And good to know that, the blog helped. Sometimes the wordings in Provisioning can be confusing :). It's trying to say that, once you download the Portlet from Upgrade Center, Configure it as desired, if you want you can disable the switch for SAP Best Practices. All configurations should be moved from Dev to Production after testing, via the different tools available to move configuration in SuccessFactors. Your client should be able to move this portlet and associated configuration in People Profile, RBP etc. just like other changes.

      Hope that helps.


      Author's profile photo Christopher Mvelase
      Christopher Mvelase

      Hi Rinky,


      Thank you for the article.

      While we finalizing enabling report stories for the business and in the meantime wanted to do a view of the data on workforce analytics.

      How do we load the portlet data as dimensions to be able to use on WFA?




      Author's profile photo Rinky Karthik
      Rinky Karthik
      Blog Post Author

      Christopher Mvelase ,

      My WFA skills are a bit rusty, but I will see if I can find an answer for you from some of our WFA experts. Can you mail me your question and some more details


      Author's profile photo Christopher Mvelase
      Christopher Mvelase

      Thank you will do

      Author's profile photo Gurang Rane
      Gurang Rane

      Hi Rinky,

      Very detailed article.

      Do we have IAS as mandatory pre-requisite. We currently do not have People Analytics and IAS setup but want to leverage COVID portlet Opt- In as we do not want to build from scratch.

      If we enable this Opt-in Do you see any risk to existing landscape and if we do enable can we pull reports on these MDF from Table Reports we do not want story reports.



      Author's profile photo Rinky Karthik
      Rinky Karthik
      Blog Post Author

      Gurang Rane ,


      The IAS pre-requisite is only if you want to build Report Stories/People Analytics. You can download the COVID Portlet without IAS and report on it like other MDF objects.

      Author's profile photo Colina Huynh
      Colina Huynh

      Hi Rinky,

      Could the portlet be disabled for contingent workforce?

      Thank You,


      Author's profile photo Rinky Karthik
      Rinky Karthik
      Blog Post Author

      Colina Huynh ,


      Yes, you could always use RBP to define permission.



      Author's profile photo Eugene Fourie
      Eugene Fourie

      Hi Rinky Karthik - I do have IAS in my instance, and can create Story reports.  After the upgrade, I do not have the story reports shown in my instance.

      How can I leverage the dashboards that have been built as in the screenshot?


      Author's profile photo Rinky Karthik
      Rinky Karthik
      Blog Post Author

      Eugene Fourie  , You could use the Report Story step-by-step guide to build one. We have provided that in Upgrade Center, when you download the Portlet. We didn't share the Report Story schema from the demo instance we have built because, 99% time it won't work in another instance since its based on MDF configuration and instance specific.

      I could share it with you, but it may not work in your instance.


      Author's profile photo Shirley Te
      Shirley Te

      Hi Rinky,

      This Vaccine tracker you said is available for customers using SF-EC.  So for customers using SF but not EC, like in our case we use SF and what I can see in there is within "My Profile" I see the following tabs:

      • Employee Information
      • Talent Profile
      • Compensation History
      • Merit Statements
      • Self Identification

      I also see Org Chart, Development Plan and Performance Evaluation.  Based on what I listed is what I see in our SF, will that equate to EC, because  we are told we are not licensed for EC.  If such is true(that we are not license on EC despite seeing My Profile with different tabs), does that mean we cannot leverage this Vaccination Tracker free of charge?

      Thank you.

      Kind regards,


      Author's profile photo Charles Kaberia
      Charles Kaberia

      Do we have anything similar for S/4 HANA customers without SF?

      Author's profile photo Christophe FOLLIET
      Christophe FOLLIET


      thanks for this addin portlet as it will become more and more needed for most of my european offices.

      Its working well and i already updated a lof of employees but sounds this MDF is still not visible into standard reporting table (we are still in the process to implement People analytics)

      Any info, advice on this point of reporting?

      Thanks a lot

      Author's profile photo Abhishek Gupta
      Abhishek Gupta


      We have a customer who does not have Story Reports enabled. I believe that is not a pre-requisite to have Story Reports but dashboards can be built in Online report designer as well. Please confirm.