Create an Alexa Smart Properties for Healthcare Skill by Using a Smart Properties Template


You can create a property-specific, fully-functional, Alexa Smart Properties skill by using the Smart Properties template in the Alexa Skills Kit developer console.

When you create a skill by using the Smart Properties template, you select a property type and then enter information for Alexa to use to answer questions about your property. For example, you might set up your skill to answer questions about your property such as, "What are the I.C.U. hours?" and "Is there a pharmacy on-site?"

You then build the skill, test the skill with an Alexa-enabled device, and then submit the skill for certification. The skill you create by using the template supports name-free interaction by default. After you create your skill by using the Smart Properties template, the skill is like any other custom skill and you can edit it at any time.

Modules

When you create an Alexa Smart Properties skill from a template, you add a module for each piece of data that you want Alexa to consider when formulating a response. In other words, modules encapsulate data that Alexa uses to answer users' questions. Modules also determine what questions Alexa can answer. For example, if you don't have an Amenity module and a user asks Alexa, "Can I get some toothpaste?" Alexa won't give the user a response that's specific to your property.

You can add multiple modules of each type. For example, if you want users to be able to request the visiting hours for the nursery, palliative care, and the burn unit, you add a separate Amenity module for each of these facilities.

The Alexa Smart Properties skill template supports the following modules:

Amenity module

The property might have several amenities such as TVs, smart thermostats, laundry rooms, and so on. Add an Amenity module for each amenity that you want Alexa to be able to answer questions about.

Field Description Max Length Required?

Amenity type

Amenity type. Examples: Bedding, Hand Soap, Pillows, Slippers, Taxi Service, Toothbrush, TV.

N/A

Yes

Name

Amenity name.

50 characters

Yes

Description

Amenity description.

200 characters

No

Instructions

Instructions on how to access or use the amenity.

200 characters

No

Location

Location of amenity.

200 characters

No

Accessibility

Accessibility details.

200 characters

No

Back to module list.

Dining module

The property might have several dining areas and food types. Add a Dining module for each dining service that you want Alexa to be able to answer questions about.

Field Description Max Length Required?

Dining type

Dining service types. Examples: Breakfast, Lunch, Dinner, Buffet, Coffee, Vegan, Japanese, Italian.

N/A

Yes

Name

Dining service name.

50 characters

Yes

Description

Dining service description.

200 characters

No

Phone number

Dining service phone number.

10 digits

No

Tags

One or more of: Pet Friendly, Kid Friendly, Outdoor Seat, Vegan Friendly, Sport Bar, Michelin Starred.

N/A

No

Directions

Directions to the dining service.

50 characters

No

Accessibility

Accessibility details.

200 characters

No

Business Hours

Days and hours of operation.

N/A

No

Menu Hours for each Meal Type

Menu hours for each meal type (All Day, Breakfast, Dinner, Happy Hour, Lunch).

N/A

No

Back to module list.

Event module

Events can be recurring or one-time occurrences. Examples of events are yoga classes, learning activities, and so on. Add an Event module for each event that you want Alexa to be able to answer questions about.

Field Description Max Length Required?

Event type

Event type. Examples: Christmas Party, Holiday Party, Learning, Thanksgiving Party.

N/A

Yes

Name

Event name.

50 characters

Yes

Description

Event description.

200 characters

No

Location

Event location.

200 characters

No

Event Time

Event time.

200 characters

No

Back to module list.

Facility module

The property might have several facility areas such as parking, a pharmacy, and so on. Add a Facility module for each facility that you want Alexa to be able to answer questions about.

Field Description Max Length Required?

Facility type

Facility type. Examples: Business Center, Lounge, Notary, Parking, Pharmacy.

N/A

Yes

Name

Facility name.

50 characters

Yes

Description

Facility description.

200 characters

No

Hint

Facility area hint. Visible only on Alexa-enabled devices with screens.

200 characters

No

Phone number

Facility phone number.

10 digits

No

Directions

Directions to the facility.

200 characters

No

Accessibility

Accessibility details.

200 characters

No

Back to module list.

Landline contact module

Landline contacts are contacts that your users can call when on your property. Examples are emergency contacts, a concierge, and so on. Add a Landline Contacts module for each on-site contact that you want Alexa to be able to answer questions about.

Field Description Max Length Required?

Landline contact type

Landline contact type. Examples: Chaplain, Concierge, Emergency, Reception.

N/A

Yes

Name

Contact name.

50 characters

Yes

Description

Contact description.

200 characters

No

Phone Number

Contact phone number.

10 digits

No

Back to module list.

Policy module

Policies are rules, guidelines, or plans for action for your property. Add a Policy module for each policy that you want Alexa to be able to answer questions about.

Field Description Max Length Required?

Policy type

Policy type. Examples: Checkout Policy, Insurance, Rules, Visiting Hours, Visitor Limit, Visitor Policy.

N/A

Yes

Name

Policy name.

50 characters

Yes

Description

Policy description.

200 characters

No

Back to module list.

Service module

You can provide instructions for different services on your property. Examples of services are checkout, housekeeping, and so on. Add a Services module for each service that you want Alexa to be able to answer questions about.

Field Description Max Length Required?

Service type

Service type. Examples: Complaint, Housekeeping, Laundry Service, Shuttle, Trash.

N/A

Yes

Name

Service name.

50 characters

Yes

Service Instructions

How to access or use the service.

200 characters

No

Business Hours

Days and hours of operation.

N/A

No

Back to module list.

Steps to create an Alexa Smart Properties skill by using a template

To create an Alexa Smart Properties skill by using a template in the developer console, take the following steps:

  1. Choose a skill type.
  2. Provide property information.
  3. Specify an invocation name and choose modules.
  4. Configure a test setup.
  5. Build the voice interaction model.
  6. Test the skill.
  7. Certify and publish the skill.
  8. (Optional) Further customize your skill.

Step 1: Choose a skill type

In this step, you create a custom skill based on the Smart Properties template, which is a quick-start template in the Alexa Skills Kit developer console. When you use the default skill settings, the skill is hosted by Alexa, the skill code is in AWS Lambda, and the skill code uses Node.js.

To choose the skill type

  1. Log in to the Alexa Skills Kit developer console.
  2. Click Create Skill.
  3. For Skill name, enter a descriptive name for your skill.
  4. For this tutorial, leave the Primary locale at English (US), which is the only locale that the Smart Properties template currently supports.
  5. At the top right, click Next.
  6. For Choose a type of experience, select Other.
  7. For Choose a model, select Custom.
  8. For Hosting services, leave the settings at their default values.
    These settings create an Alexa-hosted skill. With an Alexa-hosted skill, Alexa stores your code and resources on Amazon Web Services (AWS) for you. With the default settings you use here, the skill code is on AWS Lambda and written in Node.js.
  9. At the top right, click Next.
  10. For Templates, choose the Smart Properties template.
    Alexa Smart Properties skill template.
  11. At the top right, click Next.
  12. At the top right, click Create Skill.
    Alexa takes a few minutes to set up the skill.

Step 2: Provide property information

In this step, you choose the property type and provide property details.

To provide property information

  1. Continuing from the previous step, on the Create a Property page, select Alexa Smart Properties for healthcare.
  2. Expand Property Details, and then enter the following information:
    • Name – Property name.
    • Description – Property description (maximum of 200 characters).
    • Address – Property address.
    • (Optional) Year Built – Year built.
    • Accessibility – Whether the location is accessible, and if so, the accessibility features Alexa should provide when the user asks if the property is accessible (maximum of 200 characters).
    • Alexa Messages – What Alexa should say when greeting users for the first time, and when a user asks Alexa for something your skill doesn't know how to handle.
      Alexa Smart Properties property details.
  3. At the top right, click Next.

Step 3: Specify an invocation name and choose modules

In this step, you specify a skill invocation name. An invocation name is required even if your skill supports name-free interaction, because the user can still make requests like "Alexa, ask <skill invocation name> if there's free parking." For details about choosing an invocation name, see Design the Invocation Name for Your Skill and Invocation Name Requirements.

You also add modules, which hold data that Alexa can use for responses. Modules encapsulate answers to questions a user might ask. For details, see Modules.

To specify an invocation name and choose modules

  1. Continuing from the previous step, on the Build page, under Invocation, enter a skill invocation name.
    This name is the attribution wording that name-free interaction (NFI) reads out.
  2. Under Modules, click Add Module.
  3. From the Add Module list, select your module type, and then click Add. For a list of modules and their fields, see Modules.
    Alexa Smart Properties module types.
  4. Fill out the module details.
  5. At the top right, click Save.
    If the Save button doesn't return you to the Build page, review the module fields for errors; you might have missed a required parameter or entered information in an invalid format.
  6. Add a module for each piece of data you want Alexa to consider when formulating responses. You can always go back and edit or add modules later.
  7. At the top right, click Next.

Step 4: Configure a test setup

In this step, you specify the device serial number (DSN) of the Alexa-enabled device(s) that you want to use to test the skill. The device serial number is on the box of the device, and usually also on the bottom of the device. If you can't find the serial number and the device is registered to your Amazon account, you can find the serial number in the Alexa app.

The following important notes relate to the Alexa-enabled device you use for testing:

  • The device must be registered to the developer account you use to create the skill.
  • The device must be a device that Alexa Smart Properties supports. For a list of supported devices, see Supported devices.
  • The device must stay online with an internet connection throughout the entire testing process, up until and including when you submit your skill for certification in step 7.

In this step, you also specify your organization ID, if you have one. You can find your organization ID in the Alexa Smart Properties console under the Administrator tab. If you don't have an organization ID, you can request one during this step.

To configure a test setup

  1. Continuing from the previous step, on the Test your skill page page, under Add your devices, enter the device serial number of the Alexa-enabled device you want to use to test your skill, and then click +.
    Alexa Smart Properties test room creation.

    You can find the device serial number on the box of the device, or in the Alexa app by using the following steps:
    1. Open the Alexa app.
    2. At the bottom of the screen, choose the Devices icon.
    3. At the top of the screen, choose Echo & Alexa.
    4. Select your device from the list.
    5. Click the Settings (gear) icon at the top right.
    6. At the bottom, choose About.
      The serial number is displayed under Serial Number.
  2. Continuing from the previous step in the Alexa Skills Kit developer console, on the Test your skill page page, under Add your organization ID, either enter your organization ID or click Assign an organization ID for me if you don't have one.
    If you have an organization ID, you can find it in the Alexa Smart Properties management console. If you choose Assign an organization ID for me, your test room uses an Amazon-owned organization ID. In this case, you don't have access to the test room after you leave the Smart Properties template skill-creation flow.
  3. Click Create Test Room. If the developer console says that there was an issue creating your test room, you might not have clicked + after you entered the device serial number.

Step 5: Build the voice interaction model

In this step, you build the voice interaction model for your skill.

To build the voice interaction model

  1. Continuing from the previous step, on the Test your skill page, under Build Model, click Build.
    Alexa Smart Properties module building.
  2. In the meantime, under Test Voice Model, click Download PDF.
    The PDF helps you understand all the utterances that your skill can support. However, if you don't add the associated module, your skill doesn't return the response that the PDF specifies. For example, the PDF has utterances such as, "What events are today?", but if you don't add the Event module to your skill, this utterance won't return the sample response. Skill template only supports Q&A questions, not service requests.

  3. At the top right, click Next.

Step 6: Test the skill

After the model build from the previous step completes, you can start to test the skill by using the Alexa-enabled device that you specified in step 4.

To test the skill with an Alexa-enabled device

  • On the Alexa-enabled device, say, "Alexa, open <skill invocation name>."

Step 7: Certify and publish the skill

In this step, you review your skill details, answer privacy and compliance questions, and then submit your skill for certification review.

To certify and publish a skill

  1. Log in to the Alexa Skills Kit developer console and navigate to your Alexa Smart Properties skill.
  2. At the top, click Certify and Publish.
    Alexa Smart Properties skill overview and privacy and compliance questions.
  3. Under Privacy and Compliance, check the boxes that apply to your use case.
  4. At the bottom, click Submit for review.
    You'll then see a completion page with documentation, and a button that takes you out of the skill builder. After you exit the skill builder, you'll get an email through the developer account under which you built the skill. After your skill is reviewed, you'll also receive an email with the certification outcome.

(Optional) Step 8: Further customize your skill

The skill you create by using an Alexa Smart Properties template is fully functional. However, after you create your skill by using the template, you can further customize your skill at any time. The skill is a typical custom skill and you can find it in the Alexa Skills Kit developer console along with your other skills.

For example, you might want to update your skill in the following ways:

  • Update your voice interaction model – You can update dialogs, intents, slots, sample utterances, and create per-room responses and experiences. For example, you might add support for Alexa to respond, "The garbage room is at the end of the hallway to your right." For details, see Create the Interaction Model for Your Skill.

  • Update the name-free skill invocation configuration – Update your skill's supported utterances, name-free-invocation configuration, and specify other requests that name-free invocation can fulfill. For details, see Add Name-Free Interaction to Alexa Smart Properties Skills.

  • Customize the experience for Alexa-enabled devices with screens – Build new animations, graphics, images, slideshows, videos, and workflows for Alexa devices with screens. For details, see Add Visuals and Audio to Your Skill.

  • Download and edit your skill by using the Alexa Skills Kit Command-Line Interface – You can use the Alexa Skills Kit Command-Line Interface to download. You can then edit the skill and re-upload it by using the ASK CLI. For ASK CLI operations, see the ASK CLI Command Reference


Was this page helpful?

Last updated: Nov 28, 2023