SAP Knowledge Base Article - Public

2240477 - Audit Framework - Guide for customers and Frequently Asked Questions - Bizx Platform

Symptom

The Write Audit framework (Based on Golden Gate Replicaiton ) described in this KBA is no longer supported. We are releasing new self-service audit capabilities - General Audit Framework - that will replace the Golden Gate Audit Framework and due this reason we are no longer accepting new Audit enablement requests.

 Please use Change Audit Log to generate change audit report. for more information, please refer to KBA:2618848 and help portal link]

  • What is the audit framework ?
  • What are the types of audit available in audit framework ?
  • How can I activate audit framework for my instance ? [NO LONGER SUPPORTED]
  • How do I request my audit data once audit framework is enabled ? Is there a template ?
  • AUDIT FRAMEWORK FAQ
    • Does activating audit framework impact the performance of my BizX instance ?
    • Can I request audit framework on Preview (Early test release) datacenters ? What if I'm migrating my instance from one datacenter to another ?
    • Can audit framework handle refresh tasks or configuration changes ?
    • How does the audit framework actually save and structure the data ?
    • What information can I find on the compensation specific audit ?
    • Are there any other modules that offer auditing capabilities outside of the audit framework ?

Environment

  • BizX Platform - Audit framework

Resolution

  • What is the audit framework ?

    The Audit framework is a free opt-in feature designed to record any changes to customer data.
    This includes additions, deletions and modifications to customer data.

    This framework supports auditing for the core SuccessFactors Talent modules including Employee Central.

    It does not support auditing for the Learning (LMS), Recruiting Marketing (RMK), JAM and Workforce Analytics/Planning modules.

    By default, a maximum of 90 days of audit information is retained, and audit information is captured from the day the audit framework is enabled for a customer.

  • What are the types of audit available in audit framework ? [NO LONGER SUPPORTED]

    The following auditing options are available:
    • Basic: Auditing of only permission related tables
    • Comprehensive: Auditing of all tables supporting the core SuccessFactors Talent modules including Employee Central (Performance and Goal Modules are not available for Comprehensive Auditing)
    • Compensation : Auditing of all Compensation tables
    • MDF: Auditing of all MDF objects
      Note 1: Only one of the above types of Audit Frameworks can be enabled in an instance at any one time.
      Note 2: Comprehensive audit covers Compensation and MDF Auditing. The difference between Comprehensive and other audit types is the amount of data that will be kept.

  • How can I activate audit framework for my instance ? [NO LONGER SUPPORTED]

    Please be aware that we are no longer we are no longer accepting new enablement request of Audit Framework feature. We are releasing new self-service audit capabilities that will replace the Audit Framework and the feature will be discontinued.

     

  • How do I request my audit data once audit framework is enabled ? Is there a template ?

    When you find that the data you are needing does not have a standard report via analytics, you will need to request an audit report via Support.
    Please note that there may be some data that is not possible to report on even via the audit framework at this time. Support will work with you to determine what is possible and what is not possible.
    Requests should be directed to the Platform support team. Please provide thorough and clear details on the data you are needing, including: Usernames, date period, module, actions and any specifics that can help pinpoint exactly the required data.

    These are the steps that the support incident should follow:

      1. Open an incident under the Foundation & Tools category (LOD-SF-PLT) with this Template request:

        Data required : For example: "Audit on Employee profile fields A,B,C,D, and custom01 to custom15."
        User population: For example "Audit on all users" or "Only users in division ABC"
        Time frame : For example: "Audit for last 90 days"

        This should be sufficient for the majority of requests. If Engineering require further information support will let you know.

      2. The Platform support team will create an internal JIRA  (PLT-TASK-Audit Framework) to request this data.
        Turnaround Time: It can take several weeks to process these non-critical requests. (For urgent requests please use standard escalation processes)
        If you already requested this data in the past, please refer to the previous support incident. Support will be able to re-use the queries built by Engineering and speed up the request by only requesting the output from Operations team.

      3. Once support has obtained your report they will update your case with the file.
        If your file has very sensitive data and needs special handling, please let support know this

        Notes:
        Very large reports may require other delivery methods, since there can be limitations for very large attachments in cases.
        Also keep in mind, it is not possible to report on everything all in 1 file. Your query request should be focused to produce a file of reasonable size that we can manage, otherwise it may need to be broken up into smaller files to be successfully delivered.

        For Internal Support & Partners
        JIRAs should generally start out as PLT, but may be routed to the specific module team to have a specific query written.
        Platform team will work with ENG and the module team via a COSR (Database script request) to execute the query, and generate the report. 

  •  AUDIT FRAMEWORK FAQ
    • Does activating audit framework impact the performance of my BizX instance ?
      Activating the audit framework does not impact your BizX instance at all.
      This is because the audit framework database is separate from the BizX instance and there is no additional process that needs to run inside your existing BizX database that could impact the performance.

    • Can I request audit framework on Preview (Early test release) datacenters ? What if I'm migrating my instance from one datacenter to another ?
      At this point in time we are still working on enabling the audit framework in the Preview (Early test release) data centers. If you wish to know the current status please inquire via a support incident.

      In very rare scenarios, you might use the instance migration process (typically with the help of our professional services team)
      If your instance is being migrated from one datacenter to another and you have audit framework in the source instance, please inform your migration team so that they can re-implement the audit framework in the target datacenter and instance.
      You should also ask them to migrate the existing audit data if you want to retain it.

    • Can audit framework handle refresh tasks or configuration changes ?
      Refreshes (copying the data from one instance to another instance) doesn't have any impact on your audit framework feature. It will continue to capture the new data.
      Bear in mind that the audit data will reflect the "new" data which was refreshed so when querying for changes over time you may see some "breaks" in the logical patterns for audit on the dates before and after the refresh took place.

    • How does the audit framework actually save and structure the data ?
      The audit framework is replicating the database tables that are relevant for the Audit type you selected. Additionally it captures context on each one of the changes in terms of who, when, what and how the data was changed.
      For further information on this topic please refer to KBA 2307420

    • What information can I find on the compensation specific audit ?
      Please refer KBA 2084156

    • Are there any other modules that offer auditing capabilities outside of the audit framework ?
      • Performance and goals:
        The Performance and Goals modules offer specific auditing for some aspects of their data. Refer to KBA 2075945
      • Employee Central:
        There are ad-hoc reports that allow some auditing on Employee Central. We would advise reviewing the following articles: KBA's 2080152 and 2080162

Keywords

auidt, auditing, audit framework, report, hana, Basic, Comprehensive, Compensation, MDF, how to, , KBA , LOD-SF-PLT , Foundational Capabilities & Tools , LOD-SF-PLT-AUDR , Request for Audit Report , LOD-SF-PLT-AUDE , Enable Audit Framework , How To

Product

SAP SuccessFactors HCM Suite all versions