Students
Use the search service to search for SAP SuccessFactors end users.
Table-Specific Information
Select
The component uses the SAPSuccessFactorsLMS API to process WHERE clause conditions that are built with the following columns and operators:- StudentID supports the =, !=, and LIKE comparison operators. Server-side support for the LIKE operator is restricted to CONTAINS clauses.
- DomainID supports the =, !=, and LIKE comparison operators. Server-side support for the LIKE operator is restricted to CONTAINS clauses.
- FirstName supports the =, !=, and LIKE comparison operators. Server-side support for the LIKE operator is restricted to CONTAINS clauses.
- LastName supports the =, !=, and LIKE comparison operators. Server-side support for the LIKE operator is restricted to CONTAINS clauses.
- MiddleName supports the =, !=, and LIKE comparison operators. Server-side support for the LIKE operator is restricted to CONTAINS clauses.
- PersonExternalID supports the =, !=, and LIKE comparison operators. Server-side support for the LIKE operator is restricted to CONTAINS clauses.
- PersonGUID supports the =, !=, and LIKE comparison operators. Server-side support for the LIKE operator is restricted to CONTAINS clauses.
- IsActive supports the = comparison operator.
- OrganizationID supports the = comparison operator.
- JobPositionID supports the = comparison operator.
The component processes other filters client-side within the component.
For example, the following queries are processed server-side:
SELECT [Admin].[Search_Service].[Students].* FROM [Admin].[Search_Service].[Students]
Columns
| Name | Type | References | Required for Select | Description |
| StudentID [KEY] | String | The unique ID of a user in the Learning Management System (LMS). This is recognized within the LMS only. If you want an ID that is recognized throughout SAP SuccessFactors HCM Suite, you want to get the Person GUID or Person External ID. | ||
| AccountID | String | The financial account ID. | ||
| Addr | String | The street address of a user. | ||
| City | String | The city of the user. | ||
| Cntry | String | The country code of the user. Country codes are defined in the system. | ||
| CompID | String | The company ID of the entity. | ||
| DomainID | String | The security domain ID of the entity. You can associate a record with an access domain to control the administrators who can access the record. What an administrator can access and do for a record depends on how you configured the entity, function, and workflow domain restrictions of the role ID that is associated with the administrator. | ||
| EmailAddr | String | The user's email address. | ||
| EmpStatID | String | You can associate employees with a status that identifies their standing in the company (for example, full-time, on leave, or suspended). | ||
| EmpTypID | String | Users have an employee type, such as contractor, consultant, salaried, or part-time. You can use the employee type as an attribute to match users for an assignment profile or as search criteria when you execute a search for example, you could run an Account Data report for users whose employee type is full-time | ||
| FirstName | String | The given name of a user. | ||
| FullTime | Bool | Is the user a full time employee? | ||
| HasAccess | Boolean | Does the user have access to the Learning Management System (LMS)? | ||
| HireDate | Datetime | The user's hire date. Hire date can be used to assign training. For example, a learning administrator might assign an onboarding program for all users hired after a given date. | ||
| JobLocID | String | The unique ID of the user's physical location. | ||
| JobPosID | String | The unique job CODE of the user. This can be confusing because it is sometimes returned with POSITION in the parameter name. | ||
| LastName | String | The family name of a user. | ||
| Locked | Boolean | Is the user locked out of the system? | ||
| MiddleName | String | The middle initial of a user. | ||
| NativeDeeplinkUser | Bool | If set to N then the user receives deep links that work in an integrated SuccessFactors HCM Suite environment. If set to Y, then the user receives links that work in a native learning environment (SuccessFactors Learning only). | ||
| NotActive | Boolean | Whether the user is not active. | ||
| OrgID | String | The unique ID of the organization that the entity belongs to. Organizations define a structure to your users, and users' organization controls how the system recognizes them. For example, you can reserve space for an organization in a course. Users belonging to the organization can occupy the reserved space. | ||
| PersonExternalID | String | A mutable identifier for one person across all of SuccessFactors HCM Suite. This is different from an LMS user ID (often called STUDENT ID). The student ID is used only within the Learning Management System (LMS). It is also different from the PERSON GUID, which is used throughout SAP SuccessFactors HCM Suite but is immutable. In most cases, you use the person ID when you want to call a single user throughout the suite. | ||
| PersonGUID | String | An internally generated, immutable identifier for one person across all of SuccessFactors HCM Suite. This is different from an LMS user ID (often called STUDENT ID). The student ID is used only within the Learning Management System (LMS). It is also different from the PERSON ID, which is used throughout SAP SuccessFactors HCM Suite but is mutable. In most cases, you use the person ID when you want to call a single user throughout the suite. | ||
| PosNumID | String | The position number ID. | ||
| Postal | String | The postal code of the user. | ||
| ProfileStatus | String | The status column from pa_stud_tp table, indicating if the student is an active employee. EXPIRED | ||
| RegionID | String | Users, instructors, and training facilities are associated with regions. The system uses regions to find training close to users. For examaple, courses taking place in a facility that is in the same region as the user. Companies can also use region to inform some reports. | ||
| RegularTempID | String | Companies use the regular temp ID to search and report on users in categories of their regular and temporary work. For example, a company might want to define several types of temporary workers. | ||
| RoleID | String | The security role ID of the user. | ||
| IsActive | Bool | If the value is true then the user is active. If the value is false, then the user is inactive. | ||
| OrganizationID | String | The unique ID of the organization that the entity belongs to. Organizations define a structure to your users, and users' organization controls how the system recognizes them. For example, you can reserve space for an organization in a course. Users belonging to the organization can occupy the reserved space. | ||
| JobPositionID | String | The unique job CODE of the user. This can be confusing because it is sometimes returned with POSITION in the parameter name. | ||
| SelfReg | String | Is the user self registered? Value can be Y for self registered or N for not self registered. | ||
| State | String | The state or province of the user. | ||
| SuperField | String | The user ID of the user's supervisor. | ||
| TermDate | Datetime | The date that the user separated from the company. The termination date cannot be in the future and it cannot be before the hire date. | ||
| TotalCount | Long | The total number of records found for this request. |