Getting Started

Help center / Getting started

Getting started

From installation to your first filled PDF

This guide walks Salesforce admins through the setup of Arimba, step by step. Follow the steps in order the first time. Afterwards, your users can generate filled PDFs from any record with a few clicks.

Before you start

  • Administrator access to the Salesforce org where you install Arimba. We recommend starting in a sandbox.
  • A PDF form you want to fill, for example an application or registration form your team fills by hand today.
  • Adobe Acrobat with the form tools, to add form fields to your PDF. [ADD: or use the Arimba visual editor]

The steps at a glance

  1. Install Arimba
  2. Add the Arimba component to a record page
  3. Create a document set
  4. Create a query
  5. Prepare your PDF template
  6. Upload the template
  7. Generate your first PDF

1. Install Arimba

  1. Open the Arimba listing on AppExchange.
  2. Click Get It Now and log in to AppExchange.
  3. Choose where to install Arimba: production or sandbox.
  4. Accept the terms and conditions and click Confirm and Install.
  5. Choose the installation options and click Install.

2. Add the Arimba component to a record page

Users generate PDFs from a component on the record page. Add it to every object you want to create documents from, for example Account or Opportunity.

  1. Open any record of the object.
  2. Click the gear icon at the top right and choose Edit Page.
  3. Under Custom – Managed, find the documentGenerator component and drag it to the place you want on the page.
  4. Save and activate the page.

3. Create a document set

A document set works like a folder: it groups the PDF templates that belong to one process or area, so users find the right template quickly.

  1. Open the Arimba app from the App Launcher.
  2. Go to the Document Sets tab and click New.
  3. Give the document set a clear name, for example “Customer cases”, and save it.

4. Create a query

A query tells Arimba which Salesforce data to put into your template. Queries use standard SOQL, so if you know Salesforce, you already know the syntax.

  1. In the Arimba app, open the Queries tab and click New.
  2. Give the query a name that says which data it returns, for example “AccountDetails”. You use this name in your template later.
  3. Enter your SOQL query in the Statement field and save.
SELECT Name, Postcode__c FROM Account WHERE Id=:recordId

Important: end your query with WHERE Id=:recordId. That way it returns the data of the record the user is on when they generate the PDF. For a fixed record, use its record Id instead.

The New Query form with a query name and a SOQL statement
Creating a query in the Arimba app

5. Prepare your PDF template

Open your PDF in Adobe Acrobat and use the form tools (Prepare a form) to add a text field wherever a value should appear. The name of each field decides which Salesforce value goes into it:

QueryName.OBJECTNAME_FIELDNAME

For the query from step 4, the field names are AccountDetails.ACCOUNT_NAME and AccountDetails.ACCOUNT_POSTCODE. [CHECK: exact name for custom fields]

Important: field names are case-sensitive. Always write the object name and the field name in capital letters.

Form fields named after the Arimba scheme in Adobe Acrobat
Naming form fields in Adobe Acrobat

Fields from the current record, without a query

For values on the record itself, you don’t need a query. Use the master flag instead:

MASTER.OBJECTNAME_FIELDNAME

This only works for fields that are available on the current record. For data from related records, use a query.

Tip: let long values fit

Values can vary a lot in length. In the form field’s properties, open the Appearance tab and set Font Size to Auto. Arimba then shrinks long values to fit the field instead of cutting them off.

The Appearance tab of a form field with Font Size set to Auto
Setting the font size to Auto

When all fields are in place, save the PDF.

6. Upload the template

  1. Open the document set you created in step 3.
  2. In the Notes and Attachments section on the right, upload your PDF template.

The same list shows which templates the document set already holds.

7. Generate your first PDF

  1. Open a record whose page has the Arimba component.
  2. In the component, select a document set from the list or search for it.
  3. Select the templates you want to fill. You can select several at once.
  4. Click Download PDF. A preview shows the values Arimba will use, so you can check that all data is there before you download.
The Arimba component on a record with the document set search field
Selecting a document set on the record
The data preview listing each merge field and the value it will receive
Checking the values in the data preview

That’s it: your first PDF is filled with Salesforce data.

Next steps

Calculated fields

Add calculated values such as discounts or totals.

Formats and fonts

Control decimal places and change the font of a field.

Advanced queries

Pull data from related records across objects.

Stuck somewhere?

Send us a request with the support form and we’ll find a solution together.