Skip to content

Setting Up JustOn SCHUFA Inquiries

Info

JustOn SCHUFA Inquiries requires at least the Salesforce Enterprise Edition.

Credit rating by SCHUFA is a paid service. Before you can use JustOn SCHUFA Inquiries, you must close a corresponding contract with SCHUFA. The contract must specify, among others, the user name and password for accessing the SCHUFA API.

Setting up JustOn SCHUFA Inquiries involves the following tasks:

Installing JustOn SCHUFA Inquiries

Info

JustOn SCHUFA Inquiries requires at least the Salesforce Enterprise Edition.

To install JustOn SCHUFA Inquiries in your org:

  1. Open the app listing in Salesforce AppExchange to get JustOn SCHUFA Inquiries.
  2. Click Get It Now to invoke the installation procedure.
  3. Follow the instructions and provide the required information as necessary.

    When prompted

    1. Choose the option Install for Admins Only.

      Why installing for admins only?

      For installing JustOn SCHUFA Inquiries, we strongly recommend to choose the option Install for Admins Only. This requires to set the appropriate permissions for the users in your org manually, using the permission sets shipped with the JustOn SCHUFA Inquiries package.

      This approach, however, has important advantages:

      • Permission sets allow accessing objects and object fields, that is, they control which data users can see and edit. This way, users can do their job without seeing data they do not need to see, which helps to minimize the risk of abuse and loss of data.
      • Using the permission sets makes sure that JustOn SCHUFA Inquiries works consistently as intended. Since the permission sets are included with the JustOn SCHUFA Inquiries package, they are upgraded as new objects or fields, Visualforce pages etc. are added with new JustOn SCHUFA Inquiries releases.
    2. Allow access to third-party websites.

      Why allowing access to third-party websites?

      Upon installing JustOn SCHUFA Inquiries, you are prompted to allow communication with a number of third-party websites. This is because the package contains remote site settings for the listed SCHUFA web services, which are required for JustOn SCHUFA Inquiries to operate.

      schufa_install_3rd_party_access
      Allowing access to SCHUFA web services

Creating Named Credential

After installing and for testing purposes, JustOn SCHUFA Inquiries uses a test endpoint. To switch to production mode, your company must enter into a contract with SCHUFA, and create a new named credential, providing your company-specific access information.

The user name and password for accessing the SCHUFA API are given by SCHUFA on contract conclusion.

  1. Click to enter Setup, then open Named Credentials.

    In Salesforce Lightning, navigate to Security > Named Credentials.

    In Salesforce Classic, navigate to Security Controls > Named Credentials.

  2. Click New Named Credential.

  3. Specify the following details.

    Field Required Value
    Label Schufa
    Name Schufa
    URL https://kycnow.fino.cloud/api/v1/
    Identity Type Named Principal
    Authentication Protocol Password Authentication
    Username clientID as provided by Schufa
    Password clientSecret as provided by Schufa
    Generate Authorization Header false
    Allow Merge Fields in HTTP Header true
    Allow Merge Fields in HTTP Body true
  4. Click Save.

Assigning License

The users who will work with JustOn SCHUFA Inquiries need a JustOn SCHUFA Inquiries license.

  1. Click to enter Setup, then navigate to Users > Users.
  2. Open the details of the relevant user, and scroll to the Managed Packages section.
  3. Click Assign Licenses.
  4. Select the JustOn SCHUFA Inquiries package, and click Add.

To add licenses to multiple users at once:

  1. Click to enter Setup, then navigate to Apps > Packaging > Installed Packages.
  2. Click Manage Licenses in the row of JustOn SCHUFA Inquiries.
  3. Click Add Users.
  4. Select the relevant users, and click Add.

For details, see Managing Licenses for Installed Packages in the Salesforce Help.

Assigning Permissions

JustOn SCHUFA Inquiries ships with the following default permission sets:

Permission Set Description
Schufa Full Access Read/write access to the Schufa Inquiry object. Enables users to create Schufa inquiries, irrespective of any role-based restrictions.
Can be used only in combination with the Read/Write permission set.
Schufa Read Only Read-only access to the Schufa Inquiry object.
Schufa Read/Write Read/write access to the Schufa Inquiry object. Enables users to create Schufa inquiries.

As an org administrator, you can add or remove the permission set assignments for your users as necessary. Be aware that any user who is supposed to do more than just view certain data requires Write access to the relevant objects and fields.

Info

JustOn recommends not to alter the Salesforce default access setting Public Read/Write (as part of the sharing settings) for the Account object. If your business requires to do so, however, make sure to assign Write access to the users or profiles who create or update inquiries.

Assign the relevant permission sets to all users who will work with JustOn SCHUFA Inquiries.

  1. Click to enter Setup, then navigate to Users > Users.
  2. Select a user who will work with JustOn SCHUFA Inquiries.
  3. In the Permission Set Assignments section, click Edit Assignments.
  4. Select the required permission sets and move them to the Enabled Permission Sets column.

    column_enabled

  5. Click Save.

For details, see Assign Permission Sets to a Single User in the Salesforce Help.

Integrating With Custom Objects

By default, JustOn SCHUFA Inquiries integrates with standard Salesforce objects, including Lead, Account, Contact and Opportunity. Your business may, however, use a custom object to manage customer data. In this case, you probably want the credit rating functionality available on this object.

To this end, JustOn SCHUFA Inquiries allows for enabling custom objects. Note, however, that this is possible for B2B requests only, and therefore supports the fields for corporate accounts.

  1. Click to access the App Launcher, and select Schufa Inquiry Config.
  2. Click Add SObject.

    This opens a dialog for adding the new object and configuring the address fields.

  3. In the sObject field, select the relevant object.

  4. Specify the fields to use for pre-setting address data.

    In the Company Name and address fields, specify the API names of the custom object's fields that hold the relevant company name and address information. This will pre-fill the form when associating the Salesforce data record with the company data records at SCHUFA.

    schufa_add_obj

  5. Click Save.

    This adds the Schufa-relevant fields to the custom object, enabling the records to be linked with SCHUFA and to save the retrieved credit rating data.

    Schufa-relevant fields
    Label Field API Name Data Type Description
    Current Score SchufaCurrentScoreScore__c Number(4,0) The company's current Schufa score (credit rating index).
    Current Score Date SchufaCurrentScoreDate__c Date Date of the company's current Schufa score rating.
    Current Score Risk Quota SchufaCurrentScoreRiskQuota__c Percent(4,2) The company's current credit default rate as determined by Schufa.
    Fetch Time SchufaFetchTime__c Date/Time Time of the most recent inquiry import.
    Insolvency Application Date SchufaInsolvencyDatesApplication__c Text(255) Date of the insolvency application as recorded by Schufa.
    Insolvency Status Code SchufaInsolvencyStatusCode__c Number(18,0) Codified insolvency status as determined by Schufa.
    Schufa ID SchufaId__c Text(100)
    (Unique Case Insensitive)
    Unique company identifier in the Schufa company records.
    Schufa Inquiry SchufaInquiry__c Lookup(Schufa Inquiry) Reference to the most recent inquiry for the account. Can be empty if no inquiry has been fetched previously.

Info

The Schufa Inquiry Config dialog lists the existing object configurations. Clicking Edit on a configuration allows for modifying the address field associations.

Enabling B2C Requests

If your company works with consumers, you must

  • Configure the feature codes according to your organization's requirements

    There are various criteria that determine the scope of available legitimate interests – in particular, the industry in which an organization operates. That is, a specific combination of an industry with a legitimate interest makes up a specific feature code. Your feature code configuration determines the available options when selecting the legitimate interest for consumer inquiries (B2C-type requests).

  • Associate address fields of your Salesforce customer data with person data records at SCHUFA

Configuring Feature Codes

To set the industry type for your organization:

  1. Click to access the App Launcher, and select Schufa Inquiry Config.
  2. In the User Industry field, select the industry in which your organization operates.

    This preselects a number of likely legitimate interests for the selected industry.

    schufa_config_industry

  3. Modify the legitimate interests as required.

    • To add one or more legitimate interests, select them in the Available column and move them to the Selected column.
    • To disable one or more selected legitimate interests, select them in the Selected column and move them to the Available column.
    • To modify the display order, select a legitimate interest in the Selected column and move it up or down.
  4. Click Save.

    This defines the available options when selecting the legitimate interest for consumer inquiries. The combination of an industry with a legitimate interest makes up a specific feature code, as required by SCHUFA.

Associating Address Fields

Consumer inquiries (B2C-type requests) require the address fields available on the data records at SCHUFA to be set, including First Name, Last Name, Birth Date, Gender, Street, City, ZIP Code, Country.

Note

You may have to add a Gender field to the relevant object(s). It is not available in Salesforce by default, but the SCHUFA API requires it for consumer inquiries.

Make sure that your Gender field produces the text values M, W or D, because the SCHUFA API does not accept the gender information in another format. The field type (picklist, formula) does not matter.

To associate these fields with the corresponding fields on the Lead, Account, Contact or Opportunity:

  1. Click to access the App Launcher, and select Schufa Inquiry Config.
  2. Click Edit on the relevant object configuration.
  3. In the B2C Config section, specify the fields to associate with the SCHUFA address data.

    Make sure to use the field API names.

    schufa_config_b2c_addr

  4. Click Save.

    This associates the current object's address fields with the SCHUFA address fields. This association is required to link your Salesforce customer data with person data records at SCHUFA (usually done with the first data retrieval).

Enabling User Interface

You can make the credit rating functionality available to users

In addition, enabling the user interface involves

Info

The package provides

  • Schufa Account Record Page – a modified Account page, which already includes the Schufa inquiry component
  • Schufa Account Layout – a modified Account detail view, which already includes the Schufa-relevant fields and the Schufa Inquiries related list

So if you want the credit rating functionality to be available on accounts, you can directly use the provided page and layout, assigning them to selected user profiles (see Activate Lightning Experience Record Pages and Assign Page Layouts in the Salesforce Help).

Adding Schufa Inquiry Button

To add the Schufa Inquiry button to the relevant object's detail page:

  1. Navigate to the object management settings of the relevant object.

    Click to open the Setup menu and select Setup, then open Objects and Fields > Object Manager > Object.

  2. Click Page Layouts.

  3. Click Edit in the row of the layout you want to modify.
  4. Add the Schufa Inquiry button to the page layout.

    In Salesforce Lightning, drag the button from the Mobile & Lightning Actions palette to the Salesforce Mobile and Lightning Experience Actions section.

    In Salesforce Classic, drag the button from the Buttons palette to the Custom Buttons area.

  5. Click Save.

    This makes the Schufa Inquiry button available on the relevant object's detail page, enabling users to use the credit rating functionality on the relevant object records.

Adding Schufa Inquiry Component

To add the Schufa inquiry component to the relevant object's record page:

  1. Navigate to the object management settings of the relevant object.

    Click to open the Setup menu and select Setup, then open Objects and Fields > Object Manager > Object.

  2. Click Lightning Record Pages.

  3. Open the relevant page or click New to create a new one.
  4. Modify the page layout.

    Add, move, edit or remove components as necessary.

    Make sure to add the schufaInquiry component to the corresponding region of the record page. The component schufaInquiryAction is the overlay dialog displayed when clicking the Schufa Inquiry button.

  5. Click Save.

  6. Click Activate.

    This makes the customized record page available to users, enabling them to use the credit rating functionality on the relevant object records.

Info

When you save the customized record page for the first time, you can activate it from the Save dialog. Later, you can use the Activation... dialog.

For more details about editing Lightning pages, see Create and Configure Lightning Experience Record Pages in the Salesforce Help.

Adding Schufa-Relevant Fields

To add the Schufa inquiry fields to the relevant object's detail view:

  1. Navigate to the object management settings of the relevant object.

    Click to open the Setup menu and select Setup, then open Objects and Fields > Object Manager > Object.

  2. Click Page Layouts.

  3. Click Edit in the row of the layout you intend to modify.
  4. Drag the Schufa-relevant fields to the page layout as necessary.

    Optionally, add a new section for the Schufa-relevant fields.

  5. Click Save.

    This adds the selected Schufa inquiry fields to the object's detail view, providing an overview of the most recent inquiry information on the relevant record.

To add the Schufa Inquiries related list to the relevant object's detail view:

  1. Navigate to the object management settings of the relevant object.

    Click to open the Setup menu and select Setup, then open Objects and Fields > Object Manager > Object.

  2. Click Page Layouts.

  3. Click Edit in the row of the layout you intend to modify.
  4. Select the Related Lists palette.
  5. Drag the Schufa Inquiries list to the Related Lists section.
  6. Click Save.

    This adds the Schufa Inquiries related list to the object's detail view, enabling the display of related Schufa inquiries on the relevant record.

Scheduling Inquiry Monitoring

Your business may require to continuously monitor the relevant information on your accounts. To this end, your users can request follow-up reports. With monitoring enabled, JustOn SCHUFA Inquiries writes a new inquiry record for an account once new data is available.

To retrieve the data provided by SCHUFA on a regular basis – probably daily –, you schedule a corresponding import job using Salesforce's Schedule Apex functionality.

  1. Click to enter Setup, then open Apex Classes.

    In Salesforce Lightning, navigate to Custom Code > Apex Classes.

    In Salesforce Classic, navigate to Develop > Apex Classes.

  2. Click Schedule Apex on top of the list.

  3. Specify the details as required.

    Field Value
    Job Name descriptive name
    Apex Job SchufaScheduledJob
    Frequency Weekly
    true for all days of the week
    Start current date
    End future date
    Preferred Start Time intended execution time
    This is an approximate time. Salesforce starts the job when resources are available. Select a time at which Schufa is expected to provide new data and at which there is little network activity.
  4. Click Save.

    This sets up the import of follow-up reports to be executed at the specified time. After creating the scheduled job, you can access it for modifications by navigating to Environments > Jobs > Scheduled Jobs > Manage.

Enabling Score Alert

You can set up JustOn SCHUFA Inquiries to continuously monitor your accounts' credit-rating data. In addition, your business may require to automatically notify account managers in case the score value determined by SCHUFA changes.

With monitoring enabled, JustOn SCHUFA Inquiries writes a new inquiry record for an account once new data is available. This record holds both the new score value and the previous one, allowing for comparisons.

Consequently, you can configure a custom flow that sends an email to the account owner, for example, if the current score is higher – which means: worse (see Credit Rating Index) – than the previous score. This involves two steps:

Creating Email Alert

Create a dedicated email alert for the score warning.

  1. Click to enter Setup, then open Email Alerts.

    In Salesforce Lightning, navigate to Process Automation > Workflow Actions > Email Alerts.

    In Salesforce Classic, navigate to Create > Workflow & Approvals > Email Alerts.

  2. Click New Email Alert.

  3. Specify the details as required.

    • Description
    • Unique Name: To be used when configuring the custom flow
    • Object: Schufa Inquiry
    • Email Template: Select an appropriate email template.
    • Recipient Type: Select, for example, Account Owner
    • Recipients: Select the required recipients and move them to the Selected Recipients column.
    • From Email Address

    For details, see Email Alert Actions in the Salesforce Help.

  4. Click Save.

    This creates the email alert and makes it available for the custom flow.

Creating Custom Flow

Configure a dedicated custom flow for the score warning.

Note

Depending on your use cases, the criteria for executing the flow will vary.

  1. Click to enter Setup, then navigate to Process Automation > Flows.
  2. Click New Flow.
  3. Select Record-Triggered Flow and click Create.
  4. Configure the Start element.

    Option Description
    Object The object whose record modifications are to update a source record, must be Schufa Inquiry
    Trigger The type of record change that triggers the flow, like A record is created or A record is created or updated
    Conditions The use case-specific trigger conditions, like Formula Evaluates to True
    Formula {!$Record.JSI1__CurrentScoreScore__c} > {!$Record.JSI1__PreviousInquiry__r.JSI1__CurrentScoreScore__c}
    Optimize for Actions and Related Records
  5. Click and add the following Email Alert element.

    Option Description
    Action The email alert to call, must be the email alert unique name (see Creating Email Alert)
    Input Values Invocable variable for the email
    Record ID: {!$Record.Id}

    Specify a label and an API name as required.

  6. Click Save.

    Specify a label and an API name as required.

  7. Click Activate.

    This triggers JustOn SCHUFA Inquiries to execute the flow when a new score is higher (= worse) than the previous one and sends out the corresponding email message. Note that depending on your business requirements, the criteria for executing the flow will vary.

    For further information, see Email Alert Actions and Flows in the Salesforce Help.