Workflows are the backbone of your Adobe Sign Catalog item. While adding variables and creating items makes the form appear with the appropriate fields, we also need to create a workflow that takes this information and allows Adobe Sign to send out the agreement.
Below are the steps to create an example workflow for an expense report.
As an administrator, type Workflows in the filter bar to find the Workflow Editor option under Orchestration.
In the right-hand panel, click on the + sign to the right of the workflows search field.
This begins the process of creating a new workflow by opening a New Workflow template page
- Enter a Name for the workflow
- Associate the workflow to a Table
For our expense reporting we will name the workflow “Test Expense Report” and choose the “Requested Item” table and then click submit.
A basic workflow with a Begin and End point launches.
Next we add pieces to this workflow to define our desired workflow.
Workflows connect pieces by arrows and the basic layout has our workflow simply flowing from beginning to end. We want to add things in between so we will change this by deleting the arrow from Begin to End simply by clicking the arrow and pressing the delete key.
Since we are creating an expense report item - we expect a user to attach an expense report. To do so, bring in the Adobe Sign pack that allows us to get attachment information.
Access this by selecting the Packs tab in the right-hand panel.
Drag the Adobe Sign - Get Attachment Data pack into the screen which will produce a pop-up configuration window like this:
Populate the fields:
- Name: This is the name you choose for this pack
- Stage: We can set a stage so that if we look back at this workflow we know what stage the item is in
- In this case, we know that the request is approved if we accept the attachment data
- Adobe Agreement Name: This inserts the agreement name from the front end of the form
- Adobe Email Address: Using ServiceNow User accounts, Adobe Sign can automatically find the email address of the submitter, the submitters manager and the cost center and send the agreement to them using the syntax shown
- Adobe Msg: This is a preset message that can be created in ServiceNow
Click Submit to save the pack configuration.
Next, click and drag from the Always box (on the Begin object) to the new pack object.
You can click and drag the individual objects in the workflow so that the workflow remains visually organized.
The next step in this workflow is to send the attachment out to the recipient, without a preview.
From the Pack tab in the right-hand menu, drag in the Send Attachment, No Preview pack to add it to the workflow.
The pack configuration window opens:
There are two ways to populate the fields that you see:
- You can enter the field values manually
- You can populate the fields by dragging the correct label from the Data tab on the right
- For example - from the Data tab, drag the encodedBody item to any field that asks for an encoded body item
Follow the same process for any additional packs that you add to the workflow; drag them to the screen, populate the fields.
In this expense report example, the following packs are configured as below:
Once all the pieces are in the editor window, connect them with arrows so that each step flows into the next step until the workflow reaches the end.
Drag the Failure branches to the End object so the workflow ends if there is a failure in any of the critical steps.
Now that you’ve published your workflow you can attach it to a catalog item.
- If you ever want to edit the workflow - come back to this page and click Checkout
When adding an approval or other pause to a workflow containing an Adobe Sign custom workflow activity, you may need to change the method in which the front-end catalog variables are retrieved. If you see issues with blank fields on agreements or errors stating that a variable cannot be found (for example - "Cannot read property "objectname" from undefined"), then you may need to change "workflow" to "current" in the activities that are grabbing variables.
If the activity is using:
To grab the user's email address, you may need to change it to
In order to clear up the error.
This is due to a timing issue which shows up when the workflow is paused to wait on the activity to complete.
This change is only needed if you use an activity that causes a pause such as a timer or approval.
It is highly recommended to test well before turning the workflow on in your production environment.
If you run into issues while sending out your catalog item the best way to find the error is determining the issue with the workflow. In order to do this run your catalog item and then type Requested Items in the filter bar.
Here you will find a list of requested items.
Use the column headers to sort the records, and look for a State or Document Status that indicates a problem.
Click on the item record to open an instance of the workflow
With the workflow page open, find the pack that shows the error (red object header). Clicking on this will show you what activity of the workflow the catalog item is in.
Commonly the actual error will be in the pack immediately preceding the pack that displays the red header, indicating that a bad value was passed.
Hover your mouse over the appropriate box to determine the error:
Agreement ID error: This generally deals with the Get Attachment Data pack and the error presents itself with the Send Attachment pack. This usually happens if the values in the “Adobe Email Address” field were entered incorrectly, or the email addresses of the users placed in this field are not valid.
- Ensure that the current user, the current user’s manager, and the cost center manager’s email address are all populated.
- Ensure that the current user has an associated manager.
Connect Error: Check the connection to Adobe Sign in the Adobe Sign Administration pane by typing Adobe Sign in the filter pane. Then click Connect to Adobe.
A catalog item in ServiceNow is essentially an object that an administrator creates to perform some action that can be encapsulated in one clickable item.
The following example leverages the expense report workflow built in the previous section.
Click on Catalog Items (underneath Adobe Sign Administration)
A list of all catalog items built into Adobe Sign is displayed:
Fill out the fields to best represent your catalog item:
1. Name: The name of your catalog item. Preface with “Adobe - Sign” for easy identification
2. Workflow: Click the magnifying glass to select the workflow you want to attach to this item
3. Icon: Upload an image that can represent the item as an icon
4. Short Description: Enter a short one sentence description
5. Description: The longer description of your catalog item should express the full function of the item
6. Submit: Once the Catalog Item is defined, click Submit to save it
After clicking submit you will be presented with a list of all the catalog items.
Click on the item you made and scroll all the way to the bottom to look at the variable fields.
Here you can enter variables for your catalog item.
In the example of the expense report, we see three entered variables:
- Adobe_agreeement_name: This variable takes the name of the agreement
- Cost_center: This variable finds the appropriate cost-center for the expense report
- Adobe_attach_macro: This variable finds the attachment that needs to be uploaded by a user
Do the same thing for the other variables which include a cost-center and an attachment macro.
Examples are listed below:
Once you’ve built the front-end of the form click Try it on the top right to try it!
Enter some test items in the field and see if your item works!
Once the catalog item is created, users can access the item (via the icon) from the Service Catalog or Service Portal to send signable documents (agreements).
Type Service Catalog in the filter bar and click on Service Catalog in the resulting menu.
You can find the item either in your Top Requests, or via the Adobe Sign items on the service catalog
Once an agreement item is sent, you can view the status of the item by typing requested items in the filter bar and clicking on the Requested Items link in the resulting menu.
The Requested Items presents you a page listing all the requested catalog items that have been invoked so far.
Click on any item record in the list, and you open a new window with the specific details about that item.
Individual users that want to view only the agreement items that they have sent can do so by typing my documents in the filter bar, and click on the My Documents link in the resulting menu.
Clicking on the My Documents item shows the user all the documents that are associated with their account - agreements that they have sent to others, or agreements that they have signed.
Clicking on any one line item opens a page that shows the status of the request and the document’s attached. This item acts as the store of records, allowing a real-time view of all requested actions from agreement recipients, as well as the (downloadable) signed documents.
While we can access our items in the service catalog we can also do so by using the service portal.
Creating a Service Portal Page:
Type Service Portal in the filter bar, and click on the Pages link in the resulting menu:
Once you’ve created the page, click on the item to open it.
Scroll down and click on Open in Designer
The Attach Macro is incompatible with the Service Portal. When editing a catalog item in the portal, make sure the link you provide points to a catalog item that uses pre-uploaded documents only.
Now that you’ve created the page you can go back to ServiceNow and click Try it to test your new portal page!