Creating Artifacts
Artifacts are the organization welcome, description, disclaimer and health status notices that are communicated to users through the browser and kiosk. The Artifacts page is on the Settings tab.
Tip
We recommend creating Artifacts before an organization goes live.
Note
Artifacts are zone-specific. Ensure that you have the correct zone selected in Settings -> Zone Settings -> Current Zone before you make any changes to an artifact.
This article covers:
- Template definitions
- Editing an artifact
- Adding Markdown to an artifact
- Adding an HTML link to an artifact
Artifact Template Definitions
| Template Name | Definition |
| Profile page | This is the first screen the end user sees when they use their Deep Link. |
| Start notice | This is the notice that displays to the end user before they’re taken to their profile page. The user must click an OK button to dismiss this message. |
| Disclaimer | This is the disclaimer that displays to the end user. Note: If you choose to modify this message it is important to not delete the <p> and </p> symbols from the text box. |
| No Insurance Disclaimer | This disclaimer displays to the end user and allows them to attest that they do not have insurance. |
| Tips | Enter up to 5 tips that display to the end user when they access their Deep Link. Note: The Show Health Tip option must be enabled for the Tips to display to the user. This option is located in Settings -> User Experience -> Misc Configs. |
| Vaccine Upload Confirmation | This message displays after a user successfully uploads vaccination proof. |
| Vaccination Decline Confirmation | This message displays in a pop-up when the end user clicks Decline Vaccination Proof. |
| Kit Id Instruction | These instructions display when the end user clicks the scan button at the top of their profile page. |
| User Status: Suspended | This message displays when a user tries to use their Deep Link, but their account has been suspended. |
| User Status: Terminated | This message displays when a user tries to use their Deep Link, but their account has been terminated. |
| User Status: Deactivated | This message displays when a user tries to use their Deep Link, but their account has been deactivated. |
| Self Registration | When you create a self-registration barcode in Settings -> Barcodes you will see the Headline and Description. Once a new user registers they will see the text in the New User Registration Confirmation. The Existing User Registration Confirmation text displays when a user tries to register, but their information is already in the platform. |
| BluePass | This is the message that displays to the end user when they have issued a BluePass. Note: Display variables cannot be included in the BluePass artifact text. |
| GreenPass | This is the message that displays to the end user when they have issued a GreenPass. Note: Display variables cannot be included in the GreenPass artifact text. |
| Low risk | Displays to the end user when they have been issued a No Risk badge. |
| Some risk | Displays to the end user when they have been issued a Some Risk badge. |
| High risk | Displays to the end user when they have been issued a High Risk badge. |
| Forced Quarantine | Displays to the end user when the Forced Qurantine status has been applied. |
| Temperature Scan: Success | Displays when the end user enters their temperature on their profile. This message is also used when the end user checks in through a CS Auto or CSTS Auto device. |
| Temperature Scan: Fail | Displays when the end user enters their temperature on their profile. This message is also used when the end user checks in through a CS Auto or CSTS Auto device. |
| Temperature Scan: Repeat Fail | Displays when the end user enters their temperature on their profile. This message is also used when the end user checks in through a CS Auto or CSTS Auto device. |
| Temperature Scan: No HealthPass | Displays when the end user enters their temperature on their profile. This message is also used when the end user checks in through a CS Auto or CSTS Auto device. |
| Check-in: Success | Displays when the end user checks in successfully through a CS Auto or CSTS Auto device. |
| Check-in: Repeat success | Displays when the end user checks in successfully through a CS Auto or CSTS Auto device, then checks in again. |
| Check-in: No HealthPass | Displays when the end user tries to check in successfully through a CS Auto or CSTS Auto device but does not have a HealthPass. Note: This does not mean the user is symptomatic. |
| Check-in: No Covid-19 Test | Displays when the user tries to check out, but has broken either a survey rule or a test rule. |
| Check-out: Success | Displays when the user successfully checks out. |
Tip
We recommend giving extra consideration to the Some Risk and High Risk communications. Consider what you would like your users to do if they have symptoms and offer a method of communication with you, such as an email address or phone number.
Editing an Artifact
Note
Artifact templates are written using HTML and Markdown. You will see this formatting, but your users will not.
- Select the artifact you want to edit.
Make the desired changes to the text. See the list below for display variables that can be added. Click the Restore to default button to restore the default text.
Click the Save button.
Customizing an Artifact
You can further customize your artifacts by using one or more of the display variables listed in the table below.
When you use a display variable, the information listed in the Function column will automatically display to the end user. In the example below, "<[user_name]>" will be replaced with the user's full name.
Example
<[user_name]>,
Your account has been suspended. If you think this has been done in error, please inform your supervisor, HR or organization contact.
| Display Variable | Function |
| <[user_name]> | Prints the user's full name. |
| <[date]> | Prints today’s date in MM DD format. |
| <[link]> | Prints the user's Deep Link. |
| <[org_name]> | Prints an organization's name. |
| <[org_dname]> | Prints an organization's display name. |
| <[location_address]> | Prints a location's address. |
| <[appointment_time]> | Prints a scheduled appointment's time and date. |
| <[gpe_date]> | Prints the expiry date of a GreenPass. |
| <[bpe_date]> | Prints the expiry date of a BluePass. |
| <[location_name]> | Prints a location name. |
| <[userId]> | Prints the ID of the user. |
| <[boosted]> | Prints the word "BOOSTED" on the BluePass artifact when a user has completed a booster shot. |
| <[zone]> | Displays the name of the zone assigned to the user. |
Adding Markdown to an Artifact
You can add Markdown to any artifact. Click the Formatting Help link to display a guide for using Markdown.
Adding an HTML Link to an Artifact
You can add an HTML link to any artifact that displays the Content HTML tag.
Use the example below to add a link:
