CV task pane is a tool to allow users to insert contact/CV information for individuals directly into their Word and PowerPoint documents.
The tool is activated via a button that opens a task pane from where the user can select an individual whose information they wish to insert. This information comes from the client's own data via an API which will of course be different for each client.
In Word, they can then select what level of information they wish to insert from a dropdown menu under the individual's name. This then inserts a text element from Templafy and populates it with the relevant content.
In PowerPoint, users will insert either slides from the slides library or slide elements which contain content (groups/shapes/placeholders) pre-configured to hold CV information. Once the content is selected, the user chooses the individual, and the PowerPoint content is updated appropriately.
Configuration
Plugin
Plugin here:
...\AlloyPlugins\SkabelonDesign.CVTaskPane
CMD
The following command is used to launch the task pane and load the Individuals' information:
<Cmd case="SkabelonDesign.CVTaskPane:ShowTaskPane"/>
On run, this command will refer to the configuration.json described below.
JSON
In addition to the command line, a folder called SkabelonDesign.CVTaskPane must be placed in the OfficeExtensions Content folder. This folder should contain a file called configuration.json, the content of which should look like the below example from Client:
{
"Type": "client",
"TemplafyTenant": "clienttenantname",
"AssetFolder": "text-elements/do-not-use/do-not-use-templafy-cv-blocks",
"Host": "https://xyz/api/"
}
Parameters for JSON
Type
Type is highly specific and tailored to each client. Currently available types are "xyz", "CVPartner", and "aprimo". This is because each client’s API is very different. To implement this feature, Development will need to be engaged to create a new Type.
When using “aprimo”, additional parameters must be configured in the configuration.json file, as described below.
TemplafyTenant
The prefix of the client's Templafy tenancy, i.e., SkabelonDesign.Templafy.com
AssetFolder
This folder is used within the Word implementation of the feature and points to the folder in the client’s tenant that contains the pre-configured text elements.
Host
This is the link to the client’s API. Note that we will not always be able to test against the client’s API outside of their own environment. In these instances, we can use the below URL to link to mock data.
"Host": "https://xyz/"
ViewCount
Optional Parameter. Defines the number of individuals loaded into the task pane at a time. Must be at least 15. If omitted, the default value is 20.
HostEndpoint
Appends an endpoint to the base Host URL. For example:
{
"Host": "https://api.example.com/",
"HostEndpoint": "employees"
}
This will result in API requests to: https://api.example.com/employees.
HostMapping
Required when Type is "aprimo". Maps relevant keys from the client’s API to the program. Example:
{
"Name": "DisplayName",
"Title": "JobTitle",
"EmailAddress": "eMailAddress",
"Id": "NetworkId"
}
AprimoOptions
Required when Type is "aprimo". Specifies configuration for Aprimo DAM integration. Example:
{
"AprimoTenant": "exampletenant",
"ClientId": "EXAMPLE-CLIENT-ID",
"ClientSecret": "EXAMPLE-CLIENT-SECRET",
"ClassificationId": "EXAMPLE-CLASSIFICATION",
"ReferenceField": "exampleEmailField"
}
Bindings
The bindings should be put in the alt text of the placeholder(s).
Use the following syntax:
{"BindingKey":"KnownAs", "BindingType":"Text"}
The bindings used consist of two key value pairs as shown in the example above:
BindingKey
Refers to the data point name from the client’s API
BindingType
Can be one of two values:
Image where we expect the returned content from the API to be an image.
Text where we expect the returned content from the API to be text.
Example of usage
PowerPoint
The below example contains three separate bindings. The bindings have been applied as alt text to each individual shape:
Contact name: {"BindingKey":"KnownAs", "BindingType":"Text"}
Title: {"BindingKey":"JobTitle", "BindingType":"Text"}
Image: {"BindingKey":"_imageUrl", "BindingType":"Image"}
Word Example
The below example is the equivalent of the same content in Word. The bindings have been added as content control tags, with different content controls applied around each of relevant pieces of content. Note that the BindingKey should match the key of the key/value-pair from the JSON that we are receiving from the service. The bindings used are the same as above in the PowerPoint example:
Comments
0 comments
Please sign in to leave a comment.