Paylocity¶
The Paylocity connector is a Palantir-provided driver for Paylocity.
To create a new Paylocity source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for Paylocity-specific configuration and networking. For the complete property reference, see the official Paylocity driver documentation ↗.
Configuration¶
The properties below are mandatory or recommended.
| Property | Required? | Description | Default |
|---|---|---|---|
CompanyId ↗ |
Recommended | The ID of the company file. | — |
InitiateOAuth ↗ |
Recommended | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. | REFRESH |
IV ↗ |
Recommended | The initialization vector (IV). | — |
Key ↗ |
Recommended | The secret key for the symmetric algorithm. | — |
OAuthClientId ↗ |
Recommended | Specifies the client Id that was assigned when the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. | — |
OAuthClientSecret ↗ |
Recommended | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret). This secret registers the custom application with the OAuth authorization server. | — |
RSAPublicKey ↗ |
Recommended | Set this to the public key shared by Paylocity. | — |
UsePayEntryAPI ↗ |
Recommended | Set to true if you want to access the Pay Entry API. When this property is set to true, you should specify a different location for OAuthSettingsFile. | FALSE |
UseSandbox ↗ |
Recommended | Set to true if you are using sandbox account. | FALSE |
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.paylocity.com | If UseSandbox=FALSE (default) |
| apisandbox.paylocity.com | If UseSandbox=TRUE |
| dc1prodgwext.paylocity.com | If UsePayEntryAPI=TRUE AND UseSandbox=FALSE (default) |
| dc1demogwext.paylocity.com | If UsePayEntryAPI=TRUE AND UseSandbox=TRUE |
中文翻译¶
Paylocity¶
Paylocity 连接器是一个由 Palantir 提供的驱动程序(Palantir-provided driver)，用于连接 Paylocity。
要创建新的 Paylocity 数据源，请遵循Palantir 提供驱动程序的标准设置流程，然后使用以下各节进行 Paylocity 特定的配置和网络设置。有关完整的属性参考，请参阅官方 Paylocity 驱动程序文档 ↗。
配置(Configuration)¶
以下属性为必填或推荐项。
| 属性 | 是否必填 | 描述 | 默认值 |
|---|---|---|---|
CompanyId ↗ |
推荐 | 公司文件的 ID。 | — |
InitiateOAuth ↗ |
推荐 | 指定获取或刷新 OAuth 访问令牌的过程，该令牌用于在已认证的授权用户工作时维持其访问权限。 | REFRESH |
IV ↗ |
推荐 | 初始化向量(IV)。 | — |
Key ↗ |
推荐 | 对称算法的密钥。 | — |
OAuthClientId ↗ |
推荐 | 指定创建自定义 OAuth 应用程序时分配的客户端 ID（也称为消费者密钥）。此 ID 用于将自定义应用程序注册到 OAuth 授权服务器。 | — |
OAuthClientSecret ↗ |
推荐 | 指定创建自定义 OAuth 应用程序时分配的客户端密钥（也称为消费者密钥）。此密钥用于将自定义应用程序注册到 OAuth 授权服务器。 | — |
RSAPublicKey ↗ |
推荐 | 设置为 Paylocity 共享的公钥。 | — |
UsePayEntryAPI ↗ |
推荐 | 如果要访问薪资录入 API(Pay Entry API)，请设置为 true。当此属性设置为 true 时，您应为 OAuthSettingsFile 指定不同的位置。 | FALSE |
UseSandbox ↗ |
推荐 | 如果使用沙箱账户，请设置为 true。 | FALSE |
网络配置(Networking)¶
下表列出了数据源成功运行所需访问的域名。
对于每个域名，请添加相应的出站策略(egress policy)。如果数据源部署在本地且无法直接从 Foundry 访问，请改用代理出站策略(agent proxy egress policy)；代理主机本身也必须能够访问所列出的域名。详情请参阅使用代理作为代理服务器。
| 域名 | 必需条件 |
|---|---|
| api.paylocity.com | 当 UseSandbox=FALSE（默认值）时 |
| apisandbox.paylocity.com | 当 UseSandbox=TRUE 时 |
| dc1prodgwext.paylocity.com | 当 UsePayEntryAPI=TRUE 且 UseSandbox=FALSE（默认值）时 |
| dc1demogwext.paylocity.com | 当 UsePayEntryAPI=TRUE 且 UseSandbox=TRUE 时 |