|
SKIP AHEAD TO: What metadata does Spekit read? What types of Objects can I import? How to Transfer Content from Salesforce Knowledge Articles |
Spekit's integration with Salesforce is designed to be straightforward and secure. It's a one-way, read-only process that uses Salesforce APIs to pull metadata from your objects, fields, and picklist values. This means Spekit will never write to or make any edits in your Salesforce environment.
- The user's profile permissions requirements can be found in this article.
- For information on what metadata we import, please read this section.
What metadata does Spekit read?
Spekit imports the following information about your Salesforce objects, fields, and picklist values:
For Objects:
- Label and SFDC API Name
- Type (Standard or Custom)
- Internal Description (imported as the
Definitionand can be edited in Spekit after the first sync) Fields on the object (with total field count)
Salesforce Setup Link – directs to that object in Salesforce
For Fields:
- Label and SFDC API Name
- Help Text (imported as the
Definitionand can be edited in Spekit after the first sync) - Field Type (with Calculated Formula if Formula field, or Related Picklist Values if Picklist field)
Required (Y/N) and Default Value
Salesforce Setup Link – directs to the “All Fields” view for that object
For Picklist Values:
- Label and Parent Field
NOTE: Spekit does not automatically import picklist values. You must manually import them.
What types of Objects can I import?
On the Manage Objects import screen, you can import the following types of objects:
- Standard Objects (visible by default)
- Custom Objects (visible by default)
- Installed Package Objects (requires a manual sync to see options)
- Salesforce System Objects (requires a manual sync to see options)
How to Transfer Content from Salesforce Knowledge Articles
You can easily transfer existing documentation from Salesforce Knowledge Articles into Spekit.
- Get the Knowledge Article Export File: A Salesforce Admin will need to perform a data export to get the file. Follow the instructions in the next section to get this file.
- Share the File: Once you have the export file, send it to our support team at support@spekit.co. We will upload the content for you and ensure all rich text is translated correctly.
How to Get the Knowledge Article Export File
If you don't already have the export file, a Salesforce Admin can follow these steps:
1.) Go to Salesforce Setup.
2.) In the Quick Find search bar, search for Data Export, then click on it.
3.) Click Schedule Data Export.
4.) At the top of the panel, check the boxes for Include images, documents, and attachments and Include Salesforce Files and Salesforce CRM Content document versions.
5.) In the Exported Data section, select the Knowledge__kav box. Be careful not to confuse this with the Knowledge__ka box.
6.) Lastly, click Save.
7.) After the export is complete, you'll receive an email with a link to download the file. Share this file with support@spekit.co to begin the import process.
Will Rich Text and Multimedia Be Supported?
Yes. Any rich text formatting supported in Spekit (bolding, underlines, bullet points, etc.) will be translated when we import the content.
Images and files that are hosted on Salesforce will only be embeddable in Spekit if they are publicly accessible. Images and files hosted elsewhere will be embeddable without this requirement.