SAP SuccessFactors connector specifications

Integrate with SuccessFactors for anywhere access to employee and course information.

Version details

Citrix microapps supports the latest SuccessFactors APIs.

Endpoints

Note:

Custom endpoints are not supported.

GET

POST

Service Actions

  • Enroll Student - Register student in course offering

Key Entities

The following are the main business entities that this connector addresses:

  • users
  • students
  • learning_items
  • instructors

The following is a full list of entities and their attributes (SAP SuccessFactors v0.3.0):

Entities with Attributes

enrollment (List of SAP SuccessFactors Learning student enrollments in scheduled offerings)

  • enrollment_seat_id: LONG, PK
  • student_id: STRING(128), FK(student.student_id)
  • student_email_address: STRING(512)
  • schedule_id: LONG, FK(scheduled_offering.schedule_id)
  • first_name: STRING(128)
  • middle_initial: STRING(128)
  • last_name: STRING(128)
  • enrollment_slot_id: LONG
  • enrollment_status_id: STRING(128)
  • enrollment_date: DATETIME
  • comments: STRING(-1)
  • shipping_address: STRING(512)
  • shipping_city: STRING(128)
  • shipping_state: STRING(128)
  • shipping_postal: STRING(512)
  • shipping_country: STRING(128)
  • shipping_phone_no: STRING(128)
  • shipping_fax_no: STRING(128)
  • shipping_email_address: STRING(512)
  • last_update_user: STRING(128)
  • last_update_timestamp: DATETIME
  • cancel_date: DATETIME
  • order_item_id: LONG
  • payment_order_ticket_no: STRING(128)
  • ticket_sequence: LONG
  • origin: STRING(512)
  • withdraw_pending: BOOLEAN

instructor (List of SAP SuccessFactors Learning instructors)

  • instructor_id: STRING(128), PK
  • last_name: STRING(128)
  • first_name: STRING(128)
  • middle_initial: STRING(128)
  • full_name: STRING(128)
  • primary: BOOLEAN

learning_item (List of SAP SuccessFactors Learning items)

  • sku: STRING(128), PK
  • inventory_type: STRING(128)
  • component_type_id: STRING(128)
  • revision_date: DATETIME
  • component_id: STRING(128)
  • component_type_desc: STRING(-1)
  • component_classification: STRING(128), FK(learning_items_classification.component_classification)
  • qual_id: STRING(128)
  • price: FLOAT(prec=32, scale=8)
  • is_blend_learn_regis_req: BOOLEAN
  • enable_order: BOOLEAN
  • chargeback_method: STRING(128)
  • sched_can_override_price: BOOLEAN
  • catalog_item_flag_id: STRING(128)
  • catalog_item_flag_reason: STRING(512)
  • component_source: STRING(512)
  • title: STRING(128)
  • description: STRING(-1)
  • has_price_in_pref_currenc: BOOLEAN
  • is_rating_enabled: BOOLEAN
  • average_rating: FLOAT(prec=32, scale=8)
  • total_rating: FLOAT(prec=32, scale=8)
  • total_length: FLOAT(prec=32, scale=8)
  • start_date: DATETIME
  • end_date: DATETIME
  • duration: LONG
  • duration_type: STRING(128)
  • online_status: LONG
  • available_schedule_status: LONG

learning_items_classification (List of classifications of the learning items in SuccessFactors Learning)

  • component_classification: STRING(128), PK
  • classification_label: STRING(128)

photo (List of SAP SuccessFactors user photos)

  • height: INTEGER(x32)
  • last_modified: DATETIME
  • last_modified_date_time: DATETIME
  • last_modified_with_tz: DATETIME
  • mime_type: STRING(32)
  • photo: BINARY
  • photo_id: INTEGER(x32), PK
  • photo_name: STRING(128)
  • photo_type: INTEGER(x32)
  • user_id: STRING(100), FK(user.user_id)
  • width: INTEGER(x32)

sapho_enrollment (List of SAP SuccessFactors Learning student enrollments in scheduled offerings done via Sapho)

  • schedule_id: LONG, PK, FK(scheduled_offering.schedule_id)
  • student_id: STRING(128), PK, FK(student.student_id)
  • person_guid: STRING(128)
  • enrollment_status_id: STRING(128)
  • notify_user: BOOLEAN
  • notify_instructor: BOOLEAN
  • notify_supervisor: BOOLEAN
  • notify_contacts: BOOLEAN
  • comments: STRING(-1)
  • error_message: STRING(-1)
  • warning_message: STRING(-1)
  • warning_override: BOOLEAN

scheduled_offering (List of SAP SuccessFactors Learning scheduled offerings)

  • schedule_id: LONG, PK
  • learning_item_sku: STRING(-1), FK(learning_item.sku)
  • description: STRING(-1)
  • component_type_id: STRING(128)
  • component_id: STRING(128)
  • revision_date: DATETIME
  • price: FLOAT(prec=32, scale=8)
  • start_date_time: DATETIME
  • end_date_time: DATETIME
  • days: LONG
  • location_description: STRING(-1)
  • facility_description: STRING(-1)
  • self_enrollable: BOOLEAN
  • time_zone_id: STRING(128)
  • display_in_schedule_tz: BOOLEAN
  • max_enrollment: LONG
  • enrolled_count: LONG
  • user_can_waitlist: BOOLEAN
  • chargeback_method: STRING(128)
  • item_charge_back_method: STRING(128)
  • sched_can_override_price: BOOLEAN
  • time_zone_label_value: STRING(128)
  • currency_code: STRING(128)
  • currency_desc: STRING(512)
  • available_seat_count: LONG

scheduled_offerings_instructors_mapping (An entity for associating Scheduled offerings with their Instructors.)

  • schedule_id: LONG, PK, FK(scheduled_offering.schedule_id)
  • instructor_id: STRING(128), PK, FK(instructor.instructor_id)

student (List of SAP SuccessFactors Learning students)

  • student_id: STRING(128), PK
  • person_guid: STRING(128)
  • person_external_id: STRING(128), FK(user.user_id)
  • employee_status_id: STRING(32)
  • employee_type_id: STRING(32)
  • regular_temp_id: STRING(32)
  • fulltime: BOOLEAN
  • job_location_id: STRING(128)
  • job_position_id: STRING(128)
  • domain_id: STRING(128)
  • organization_id: STRING(128)
  • company_id: STRING(128)
  • last_name: STRING(128)
  • first_name: STRING(128)
  • middle_name: STRING(128)
  • not_active: BOOLEAN
  • address: STRING(512)
  • city: STRING(128)
  • state: STRING(128)
  • postal: STRING(128)
  • country_code: STRING(128)
  • supervisor_id: STRING(128)
  • hire_date: DATETIME
  • termination_date: DATETIME
  • email_address: STRING(512)
  • has_access: BOOLEAN
  • self_registered: BOOLEAN
  • locked: BOOLEAN
  • region_id: STRING(128)
  • role_id: STRING(128)
  • profile_status: STRING(32)
  • account_id: STRING(128)
  • position_number_id: STRING(128)

students_learning_items_mapping (An entity for associating students with the learning items they have access to in SAP SuccessFactors Learning)

  • student_id: STRING(128), PK, FK(student.student_id)
  • sku: STRING(128), PK, FK(learning_item.sku)
  • student_email_address: STRING(512)

user (List of SAP SuccessFactors users)

  • manager_user_id: STRING(100), FK(user.user_id)
  • address_line_1: STRING(255)
  • address_line_2: STRING(255)
  • address_line_3: STRING(-1)
  • bench_strength: STRING(-1)
  • bonus_budget_amount: FLOAT(prec=14, scale=7)
  • bonus_target: FLOAT(prec=14, scale=7)
  • business_phone: STRING(20)
  • business_segment: STRING(-1)
  • cell_phone: STRING(-1)
  • citizenship: STRING(-1)
  • city: STRING(255)
  • comp_bonus_eligibility: BOOLEAN
  • compensation_eligible: BOOLEAN
  • compensation_read_only: BOOLEAN
  • comp_salary_eligibility: BOOLEAN
  • comp_salary_rate_type: STRING(-1)
  • comp_salary_rate_units: INTEGER(x32)
  • comp_stock_eligibility: BOOLEAN
  • competency: FLOAT(prec=14, scale=7)
  • country: STRING(255)
  • critical_talent_comments: STRING(-1)
  • date_of_birth: DATETIME
  • date_of_current_position: DATETIME
  • date_of_position: DATETIME
  • default_full_name: STRING(-1)
  • default_locale: STRING(100)
  • department: STRING(128)
  • division: STRING(128)
  • email: STRING(-1)
  • emp_id: STRING(255)
  • employee_class: STRING(-1)
  • ethnicity: STRING(-1)
  • fax: STRING(20)
  • final_job_code: STRING(-1)
  • final_job_family: STRING(-1)
  • final_job_role: STRING(-1)
  • first_name: STRING(128)
  • future_leader: BOOLEAN
  • gender: STRING(2)
  • hire_date: DATETIME
  • home_phone: STRING(-1)
  • impact_of_loss: STRING(-1)
  • impact_of_loss_comments: STRING(-1)
  • issue_comments: STRING(-1)
  • job_code: STRING(128)
  • job_family: STRING(-1)
  • job_level: STRING(-1)
  • job_role: STRING(-1)
  • job_title: STRING(255)
  • key_position: BOOLEAN
  • last_modified: DATETIME
  • last_modified_date_time: DATETIME
  • last_modified_with_tz: DATETIME
  • last_name: STRING(128)
  • last_review_date: STRING(-1)
  • level: STRING(-1)
  • local_currency_code: STRING(-1)
  • location: STRING(128)
  • lumpsum_2_target: FLOAT(prec=14, scale=7)
  • lumpsum_target: FLOAT(prec=14, scale=7)
  • married: BOOLEAN
  • matrix_1_label: STRING(-1)
  • matrix_2_label: STRING(-1)
  • matrix_managed: BOOLEAN
  • merit_effective_date: DATETIME
  • merit_target: DATETIME
  • mi: STRING(128)
  • minority: BOOLEAN
  • nationality: STRING(-1)
  • new_to_position: BOOLEAN
  • nickname: STRING(128)
  • objective: FLOAT(prec=14, scale=7)
  • onboarding_id: STRING(-1)
  • orig_hire_date: DATETIME
  • password: STRING(128)
  • pay_grade: STRING(-1)
  • performance: FLOAT(prec=14, scale=7)
  • potential: FLOAT(prec=14, scale=7)
  • promotion_amount: FLOAT(prec=14, scale=7)
  • raise_prorating: FLOAT(prec=14, scale=7)
  • reason_for_leaving: STRING(-1)
  • relo_comments: STRING(-1)
  • relo_location: STRING(-1)
  • relo_willing: STRING(-1)
  • review_freq: STRING(-1)
  • risk_of_loss: STRING(-1)
  • salary: FLOAT(prec=14, scale=7)
  • salary_budget_extra2_pct: FLOAT(prec=14, scale=7)
  • salary_budget_extra_pct: FLOAT(prec=14, scale=7)
  • salary_budget_final_pct: FLOAT(prec=14, scale=7)
  • salary_budget_lumpsum_pct: FLOAT(prec=14, scale=7)
  • salary_budget_merit_pct: FLOAT(prec=14, scale=7)
  • salary_budget_prom_pct: FLOAT(prec=14, scale=7)
  • salary_budget_total_raise_percentage: FLOAT(prec=14, scale=7)
  • salary_local: FLOAT(prec=14, scale=7)
  • salary_prorating: FLOAT(prec=14, scale=7)
  • salutation: STRING(128)
  • sci_last_modified: DATETIME
  • seating_chart: STRING(-1)
  • service_date: DATETIME
  • ssn: STRING(128)
  • state: STRING(20)
  • status: STRING(17)
  • stock_budget_option_amt: FLOAT(prec=14, scale=7)
  • stock_budget_other1_amt: FLOAT(prec=14, scale=7)
  • stock_budget_other2_amt: FLOAT(prec=14, scale=7)
  • stock_budget_other3_amt: FLOAT(prec=14, scale=7)
  • stock_budget_stock_amount: FLOAT(prec=14, scale=7)
  • stock_budget_unit_amount: FLOAT(prec=14, scale=7)
  • suffix: STRING(128)
  • sys_cost_of_source: FLOAT(prec=14, scale=7)
  • sys_source: INTEGER(x32)
  • sys_starting_salary: FLOAT(prec=14, scale=7)
  • time_zone: STRING(20)
  • title: STRING(255)
  • total_team_size: INTEGER(x32)
  • user_id: STRING(100), PK
  • username: STRING(100)
  • veteran_disabled: BOOLEAN
  • veteran_medal: BOOLEAN
  • veteran_protected: BOOLEAN
  • veteran_separated: BOOLEAN
  • zip_code: STRING(10)

SAP SuccessFactors connector specifications