HomeGuidesAPI
HomeGuidesRecipesAPI
HomeGuidesAPILog In
Guides
These docs are for v16. Click to read the latest docs for v31.

SmartCOMM Action

Suggest Edits

Overview

Use this action to submit data for further processing or to generate a document in SmartIQ using SmartCOMM Data Modal and Template Selector.

📘

Note

Contact your sales representative if you are interested in obtaining a license for the SmartCOMM action for your SmartIQ instance.

SmartCOMM Configuration Settings

  1. Obtain a license for the SmartCOMM action and configure the default values for SmartCOMM in Manage > Settings > SmartCOMM.
  • Base Uri (Required) – SmartCOMM Pure Cloud tenancy Uri. This will be of the form https://<server>.smartcommunications.cloud/one/
  • User Name (Required) – The username for the SmartCOMM account to be used.

🚧

Important

View the Consumer Key and Secret values from the SmartCOMM account setup under Settings > Security > View API Keys. These are used to gain administrator access to the application, therefore, only share this information with the required users.

  • Name – Specify a name
  • OAuth1 Consumer Key (Required) – The public key needed to sign messages when accessing the cloud. Ensure the signature method is HMAC-SHA256.
  • OAuth1 Consumer Secret (Required) – The private key needed to sign messages when accessing the cloud.
  • SamlUrl – This is the Saml Authentication URL from the SmartCOMM instance. This is optional but highly recommended to be able to seamlessly use Single sign-on for the SmartCOMM integrations. If SAML is not enabled, the SmartCOMM logon page will appear every time SmartCOMM application page is opened from Produce.
  • Appliance Uri – The optional Appliance Uri directs generation tasks to the appliance for processing. This will be of the form: https://<yourserver domain>/smartcomms. As this is a system to system integration, ensure that the SmartIQ server trusts the SSL certificate that the appliance is serving.
  1. For multiple SmartCOMM accounts, click the New Set button to configure additional SmartCOMM accounts. For example, Sandbox and Production.
930
  1. Click Save.

Usage

  1. In Design, open a project and use the actions icon to show the Actions panel.

📘

Draft Editor Question

Use Draft Editor Question to customize the fields and content within the editor.

  1. Drag and drop the SmartCOMM action onto the Finish section.
883

Once selected, the following action is displayed for configuration:

301

  1. Use the right-hand panel and check the configured SmartCOMM account. If there are multiple accounts, select the account to use from the drop-down list.

  2. Select the required inputs and configure them accordingly.

236

Inputs

InputDescription
ProjectSelect the name of the SmartCOMM project that contains the data model and template selector.
QueueIf a value has been selected from the drop-down list of available job queues, SmartIQ will call the SmartCOMM SubmitJob Asynchronous API and no document will be generated or returned to SmartIQ.
Template Selector (Required)The SmartCOMM template selector that will be used to generate the required document.
  1. Add the Data Model and the corresponding placeholders to the answers.
  2. Select the SmartCOMM action and the Documents option on the right hand of the screen.
1127
  1. Select the Custom option and select the Data Model and format from the drop-down lists.
398

Now when you run the project, the Data Model will be filled according to the answers matched to the placeholders. This will then be supplied to the Project and Template Selector specified.

Updated over 2 years ago