ADP¶
The ADP connector is a Palantir-provided driver for ADP.
To create a new ADP source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for ADP-specific configuration and networking. For the complete property reference, see the official ADP driver documentation ↗.
Configuration¶
The properties below are mandatory or recommended.
| Property | Required? | Description | Default |
|---|---|---|---|
SSLClientCert ↗ |
Mandatory | Specifies the TLS (SSL) client certificate issued by ADP that your application presents for authentication. | — |
TestConnectionEndpoint ↗ |
Mandatory | Specifies the API endpoint that the provider uses to test the connection to ADP. | workers |
UseUAT ↗ |
Mandatory | Specifies whether the provider connects to the ADP User Acceptance Testing (UAT) environment instead of production. | FALSE |
IncludeCustomFields ↗ |
Recommended | A boolean indicating if you would like to include custom fields in the column listing. | TRUE |
InitiateOAuth ↗ |
Recommended | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. | GETANDREFRESH |
OAuthClientId ↗ |
Recommended | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. | — |
OAuthClientSecret ↗ |
Recommended | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.) | — |
SSLClientCertPassword ↗ |
Recommended | Specifies the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access. | — |
SSLClientCertType ↗ |
Recommended | The type of key store containing the TLS/SSL client certificate. | PFXBLOB |
Networking¶
The table below lists the domains that the source needs to be able to access in order to successfully run.
For each domain, add a corresponding egress policy. If the source is hosted on-premises and not directly reachable from Foundry, use an agent proxy egress policy instead; the agent host itself must also be able to reach the listed domains. See using an agent as a proxy for details.
| Domain | Required |
|---|---|
| api.adp.com | If UseUAT=FALSE |
| accounts.adp.com | If UseUAT=FALSE |
| uat-api.adp.com | If UseUAT=TRUE |
| uat-accounts.adp.com | If UseUAT=TRUE |
中文翻译¶
ADP¶
ADP 连接器是一个 Palantir 提供的驱动程序(Palantir-provided driver)，用于连接 ADP。
要创建新的 ADP 数据源，请遵循 Palantir 提供的驱动程序的标准设置流程(standard setup flow)，然后使用以下各节进行 ADP 特定的配置和网络设置。有关完整的属性参考，请参阅官方 ADP 驱动程序文档(Official ADP driver documentation) ↗。
配置¶
以下属性为必填或推荐项。
| 属性 | 是否必填 | 描述 | 默认值 |
|---|---|---|---|
SSLClientCert ↗ |
必填 | 指定由 ADP 颁发的 TLS（SSL）客户端证书，您的应用程序使用该证书进行身份验证。 | — |
TestConnectionEndpoint ↗ |
必填 | 指定提供程序用于测试与 ADP 连接的 API 端点。 | workers |
UseUAT ↗ |
必填 | 指定提供程序是否连接到 ADP 用户验收测试（UAT）环境而非生产环境。 | FALSE |
IncludeCustomFields ↗ |
推荐 | 布尔值，指示是否在列列表中包含自定义字段。 | TRUE |
InitiateOAuth ↗ |
推荐 | 指定获取或刷新 OAuth 访问令牌的过程，该令牌在已认证的授权用户工作时维持其访问权限。 | GETANDREFRESH |
OAuthClientId ↗ |
推荐 | 指定分配给您的自定义 OAuth 应用程序的客户端 ID（也称为消费者密钥）。此 ID 用于在身份验证过程中向 OAuth 授权服务器标识应用程序。 | — |
OAuthClientSecret ↗ |
推荐 | 指定分配给您的自定义 OAuth 应用程序的客户端密钥。此机密值用于向 OAuth 授权服务器验证应用程序的身份。（仅限自定义 OAuth 应用程序。） | — |
SSLClientCertPassword ↗ |
推荐 | 指定访问 TLS/SSL 客户端证书存储所需的密码。如果所选证书存储类型需要密码才能访问，请使用此属性。 | — |
SSLClientCertType ↗ |
推荐 | 包含 TLS/SSL 客户端证书的密钥存储类型。 | PFXBLOB |
网络配置¶
下表列出了数据源为成功运行而需要能够访问的域名。
对于每个域名，请添加相应的出站策略(egress policy)。如果数据源部署在本地且无法从 Foundry 直接访问，请改用代理出站策略(agent proxy egress policy)；代理主机本身也必须能够访问所列出的域名。详情请参阅使用代理作为代理(using an agent as a proxy)。
| 域名 | 是否必需 |
|---|---|
| api.adp.com | 当 UseUAT=FALSE 时 |
| accounts.adp.com | 当 UseUAT=FALSE 时 |
| uat-api.adp.com | 当 UseUAT=TRUE 时 |
| uat-accounts.adp.com | 当 UseUAT=TRUE 时 |