Permalinks are direct links to your website that automatically start a Workflow, Video, or Announcement when clicked.
Permalinks are special links that automatically open the application in the browser along with the corresponding tool, assuming the player is active and the content is ready to be accessed. These unique identification strings must be added at the end of the URL of the page where the permalink content should be displayed.
The Permalinks for Workflow can be copied from 2 locations within Apty:
- Apty Studio, or
- Admin Console.
This article describes two ways of retrieving Permalinks and their usage in the section below.
NOTE: If the step permalink does not correspond to the correct page or is invalid, the flow will restart from the beginning.
Retrieve a Permalink from the Apty Studio:
To see the list of created Workflows or Announcements, log into the Apty Studio and select the application you want to work with. The Apty menu opens.
1. Click on the Workflows or Announcements icon depending on what kind of Permalink you are attempting to retrieve. The list of respective entities created for this application opens. In this case, it is assumed that you are retrieving a Permalink for a Workflow, but the process for retrieving Announcements links is the same.
2. Click the name of a Workflow for which you are retrieving a Permalink.
3. The Workflow settings screen opens. At the top right corner of the screen click the ellipsis icon (three vertical dots) to access the Copy Permalink option. Click Copy Permalink to proceed.
Info:
You have the option to copy a workflow permalink from the list of workflows by clicking on the vertical ellipses located on the right side of the workflow name.
4. Alternatively, you can obtain a Permalink for a specific Workflow Step by selecting it from the flow and repeating the procedure described in Step 3.
Retrieve a Permalink from the Admin Console:
1. Log in to the Admin Portal.
2. On the left side panel select the application you plan to work with. The application menu opens.
3. In the Application menu go to Manage > Workflows. The grid of the workflows created for this application opens.
4. Select the tile with the Workflow for which you are trying to obtain a Permalink and click the ellipsis icon (three vertical dots) to access the Copy Permalink option. Click Copy Permalink to proceed.
Permalink Usage:
The retrieved/copied Permalink will be similar to the example shown below:
| WF-9NxVgHXGBEt-Kkdqbca!5UWT |
The Permalink can be added to the URL of the application and when used, the permalink launches the application along with the Workflow to which the permalink belongs.
1. Go to the page from where the Workflow should be launched.
2. Consider the dynamic part of the URL
3. Take the URL and append it with the permalink copied previously. Insert a separator between the URL and the copied permalink to ensure proper functionality.
4. Different separators are used for different applications.
| Applications | Separator |
| Salesforce, Oracle, Other | ? |
| CA PPM | & |