SharinPix Imports Requirements

This article outlines the requirements for the following SharinPix operations:

• Image import

• Tag migration

• Tag bulk deletion

Required Import Information

Mass image imports and tag migrations are recommended to be performed by the SharinPix team.

For such imports, kindly contact the SharinPix support team first at [email protected] with:

1. A description of the import you want to achieve.

2. The number of records/ images/tags included.

3. The average image size, if applicable.

Once the import is validated by our team, you will need to provide the following additional information:

• Your organization ID.

• A CSV file including all your import data. Please refer to the Image Import, Tag Migration, Tag Bulk Deletion sections for more information on the CSV file format in each case.

• Your organization's API limit.

• Kindly also state if tag action or image sync should be launched after the import.

Note:

For small-volume imports, the SharinPix package already includes Apex methods you can easily run on your end. Some of these methods are:

• uploadAttachment: Uploads Salesforce attachments to SharinPix albums.

• uploadContentDocument: Uploads Salesforce ContentDocuments to SharinPix albums.

• uploadFromUrl: Uploads an image to SharinPix using a URL.

For more information on how to call the above methods and other SharinPix import Apex methods, please refer to the following article: Utils methods.

⚠️ Large import volumes can trigger internal safety limits, resulting in a temporary block for your organization. Please follow our volume guidelines to ensure uninterrupted service.

Image Import

Image Import from Storage to SharinPix

For image imports from your storage (for example, Amazon S3) to SharinPix, the CSV file should include the following columns:

• album_id: The album_id column should contain the 18-digit record ID on which you want the image to be uploaded.

• url: The url column should contain the public image URLs as they appear in your storage.

• tags: The tags column should contain the tag or tags to be applied to each image. If two or more tags should be applied, please ensure that all tags are added in a single cell and separated by commas as follows: tag1,tag2,tag3

Image Import from Salesforce Content Document to SharinPix

For image imports from Salesforce files to SharinPix, the CSV file should include the following columns:

• album_id: The album_id column should contain the 18-digit record IDs on which you want the image to be uploaded.

• content_document_id: The content_document_id column should contain the 18-digit Content Document record IDs

• tags: The tags column should contain the tag or tags to be applied to each image. If two or more tags should be applied, please ensure that all tags are added in a single cell and separated by commas as follows: tag1,tag2,tag3

Tag Migration

For tag migrations from one organization to another, the CSV file should include the following columns:

• Id: Should contain the IDs of the tags to be migrated.

• Name: Should contain the tags' technical name.

• Label: Should contain the tags' labels.

• Listed: Should indicate whether the tags should be available for use in your organization. Note: This column can only contain true or false (boolean).

• Visible: Should indicate whether the tags should be visible to everyone in your organization. Note: This column can only contain true or false (boolean).

• Color: Should contain the tags' label color in Hex format.

• Public: Should indicate whether the tag should be public (shared externally). This is only used for tags used to share images externally. It is excluded in most cases. Note: This column can only contain true or false (boolean).

• Allow download: Should indicate whether file downloading is permitted when the tag is public. Note: This column can only contain true or false (boolean).

Tip:

On the Tags page of the admin dashboard, a CSV download option is available at the bottom of the page that contains all the tags in your organization, with all the required columns for tag migrations.

Tag Bulk Deletion

For tag bulk deletions, only Id column is required, containing the IDs of all tags to be deleted.

Tip:

Tag IDs can be retrieved by viewing tags from the Tags page on the admin dashboard. A CSV download option is available at the bottom of the page that contains all the tags in your organization.