From 0e4ce4e00b6cebba40ee82c41d37b70b04f8e244 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 22 May 2025 14:31:00 -0400 Subject: [PATCH 1/7] Re-add missing file --- .../README.md | 48 +++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/README.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/README.md index 3a5f3f35b..c649a4f16 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/README.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/README.md @@ -4,3 +4,51 @@ description: Guide for using the ASSA ABLOY Visionline Access Control System wit # ASSA ABLOY Visionline Access Control System +## Overview + +Seam integrates seamlessly with the [ASSA ABLOY Visionline Access Control System](https://www.assaabloyglobalsolutions.com/en/hospitality-solutions/access-management-systems-for-hotels#gw-group-text-and-media-14987d7731) (ACS), a widely-used on-premises access control platform for hotels. This system supports doors, elevators, turnstiles, and gates, enabling you to secure either a single building or multiple buildings using the same setup. Visionline uses a data-on-card platform, significantly reducing installation costs because the locks can function offline. Additionally, the capability of the system to operate independently of network connectivity enhances the reliability and flexibility. + +*** + +## Supported Devices + +This integration supports all readers and wireless locks connected to the Visionline ACS. + +For detailed information about the ASSA ABLOY Visionline devices that Seam supports, see the following table and our [ASSA ABLOY Supported Devices page](https://www.seam.co/manufacturers/assa-abloy): + +{% @seam-gitbook-plugin-v2/seam-component content="" %} + +*** + +## Supported Features + +We support the following features: + +* [Managing access systems](../../products/access-systems/) +* [Issuing plastic card credentials](../../capability-guides/access-systems/managing-credentials.md#create-a-key-card-based-credential) +* [Issuing mobile access credentials](../../capability-guides/mobile-access/) + +*** + +### Device Provider Key + +To create a [Connect Webview](../../core-concepts/connect-webviews/) that enables you to connect your Visionline ACS to Seam, include the `visionline` device provider key in the `accepted_providers` list. For more information, see [Customize the Brands to Display in Your Connect Webviews](../../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews). + +*** + +## Brand-Specific Errors + +For information about Visionline ACS-related errors, including issues related to the connection between your ACS and Seam, see [Troubleshooting Your ACS](../../capability-guides/access-systems/troubleshooting-your-access-control-system.md). + +*** + +## Where to Order + +To purchase the ASS ABLOY Visionline ACS and devices, request a quote from ASSA ABLOY. + +
ASSA ABLOY Contact Pagehttps://www.assaabloyglobalsolutions.com/en/about/local-contactsassa-abloy-logo.png
From e65a7e3dfa0512b96f5735e8d0efb2d318e48413 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 22 May 2025 14:35:21 -0400 Subject: [PATCH 2/7] Update README.md --- .../README.md | 130 +++++++++++++++++- 1 file changed, 128 insertions(+), 2 deletions(-) diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/README.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/README.md index f3c93da79..f9bfa8e42 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/README.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/README.md @@ -1,6 +1,132 @@ --- -description: Learn how to develop and then launch your Visionline mobile key integration. +description: Learn how to configure your Visionline ACS for integration with Seam. --- -# Developing and Launching Your Visionline Mobile Key App +# Visionline ACS Setup Instructions +Seam's Visionline ACS integration enables you to create the following two types of applications: + +* Apps that issue and encode Visionline plastic cards +* Mobile apps that issue Visionline mobile keys + +{% hint style="info" %} +For information about Seam mobile keys, see [Mobile Access](../../../capability-guides/mobile-access/). +{% endhint %} + +Integrating Visionline with Seam consists of a development phase and a production phase. The setup processes and requirements differ between these two phases. + +This topic provides the following process overviews with links to complete instructions: + +* [Developing and Launching a Plastic Card Encoding Solution](./#developing-and-launching-a-plastic-card-encoding-solution) + * [Develop a Plastic Card Encoding App Using a Real Visionline Server](./#develop-a-plastic-card-encoding-app-using-a-real-visionline-server) + * [Develop a Plastic Card Encoding App Using a Sandbox Workspace](./#develop-a-plastic-card-encoding-app-using-a-sandbox-workspace) + * [Launch Your Visionline Plastic Card Encoding App](./#launch-your-visionline-plastic-card-encoding-app-to-a-live-visionline-system) +* [Developing and Launching a Mobile Key Solution](./#developing-and-launching-a-mobile-key-solution) + * [Develop Your Visionline Mobile Key App](./#develop-your-visionline-mobile-key-app) + * [Launch Your Visionline Mobile Key App](./#launch-your-visionline-mobile-key-app) + +*** + +## Developing and Launching a Plastic Card Encoding Solution + +The following sections describe the major steps of the setup process for developing and launching a plastic card encoding solution: + +### Develop a Plastic Card Encoding App Using a Real Visionline Server + +1. Install your Visionline application using your development account. + + Contact Seam at [support@seam.co](mailto:support@seam.co) to obtain access. +2. Configure Visionline and set it up to work with plastic cards. + 1. Unblock the required ports. + 2. Make sure that Visionline is configured with an appropriate user account. + 3. Buy and install a [Visionline card encoder](https://estore.assaabloyglobalsolutions.com/no/marine/rfid-encoder-updater-complete.html) and then connect it to your Visionline server. + 4. Set up all door locks. + 5. Use Lock Service 3G to program the door locks. +3. Create a Seam production workspace. + + You can continue to use this workspace in your production phase as well. +4. Connect your Visionline development account to Seam. + + This step includes installing and running Seam Bridge to connect your on-premises Visionline application to Seam. + +For detailed instructions, see [Developing Your Visionline Plastic Card Encoding App Using a Real Visionline Server](developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/). + +*** + +### Develop a Plastic Card Encoding App Using a Sandbox Workspace + +1. Create a sandbox workspace.\ + A sandbox workspace enables you to develop and test your app using Seam-provided virtual systems and devices. +2. Connect the virtual Visionline ACS to Seam. + +For detailed instructions, see [Developing Your Visionline Plastic Card Encoding App Using a Sandbox Workspace](developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/). + +*** + +### Launch Your Visionline Plastic Card Encoding App to a Live Visionline System + +1. Confirm that your production Visionline site meets the system requirements. +2. Make sure that Visionline is configured with an appropriate user account. +3. Purchase the required Callback option from ASSA ABLOY and import it into Visionline. +4. Connect your Visionline production account to Seam. + + Either create a new production workspace or use your existing production workspace.\ + This step also includes installing Seam Bridge. + +For detailed instructions, see [Launching Your Visionline Plastic Card Encoding App](developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/). + +*** + +## Developing and Launching a Mobile Key Solution + +The following sections describe the major steps of the setup process for developing and launching a mobile key solution: + +### Develop Your Visionline Mobile Key App + +1. Sign up for and complete the ASSA ABLOY mobile development course. +2. Install your Visionline app. +3. Configure Visionline using your development account. + 1. Unblock the required ports. + 2. Make sure that Visionline is configured with an appropriate user account. + 3. Set up your Credential Services account in the Visionline application. + 4. Configure the mobile access UUID in the Visionline application. + 5. Set up all door locks with Bluetooth low energy (BLE) profiles. + 6. Use Lock Service 3G to program the door locks. +4. Create a Seam production workspace. + + You can continue to use this workspace in your production phase as well. +5. Connect your Visionline site to Seam using your Visionline development account. + + This step includes installing and running Seam Bridge to connect your on-premises Visionline application to Seam. + + 1. Also, add your Visionline development application ID in Seam Console. + +For detailed instructions, see [Developing Your Visionline Mobile Key App](developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/). + +*** + +### Launch Your Visionline Mobile Key App + +1. Pass the ASSA ABLOY certification process. +2. Confirm that your production Visionline site meets the system requirements. +3. Configure all door locks for use with mobile keys. + + {% hint style="info" %} + This process can be quite time-consuming because it requires interaction with all locks. + {% endhint %} + + 1. Make sure that the BLE module is installed on all locks. + 2. Set up all door locks with BLE profiles. + 3. Use Lock Service 3G to program all locks. +4. Configure Visionline using your production account. + 1. Make sure that Visionline is configured with an appropriate user account. + 2. Purchase the following required options from ASSA ABLOY and import them into Visionline: + * Callback options + * Mobile Service option with your tenant account +5. Connect your Visionline production instance to Seam. + + Either create a new production workspace or use your existing production workspace. + + This step also includes installing Seam Bridge and adding your Visionline application ID in your workspace. + +For detailed instructions, see [Launching Your Visionline Mobile Key App](developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/). From c8e21ad53443c389e097719f392f7a7f572cdb0a Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 22 May 2025 14:36:06 -0400 Subject: [PATCH 3/7] Update README.md --- .../README.md | 126 ++++++++++++++++++ 1 file changed, 126 insertions(+) diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/README.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/README.md index 5099496ed..f9bfa8e42 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/README.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/README.md @@ -4,3 +4,129 @@ description: Learn how to configure your Visionline ACS for integration with Sea # Visionline ACS Setup Instructions +Seam's Visionline ACS integration enables you to create the following two types of applications: + +* Apps that issue and encode Visionline plastic cards +* Mobile apps that issue Visionline mobile keys + +{% hint style="info" %} +For information about Seam mobile keys, see [Mobile Access](../../../capability-guides/mobile-access/). +{% endhint %} + +Integrating Visionline with Seam consists of a development phase and a production phase. The setup processes and requirements differ between these two phases. + +This topic provides the following process overviews with links to complete instructions: + +* [Developing and Launching a Plastic Card Encoding Solution](./#developing-and-launching-a-plastic-card-encoding-solution) + * [Develop a Plastic Card Encoding App Using a Real Visionline Server](./#develop-a-plastic-card-encoding-app-using-a-real-visionline-server) + * [Develop a Plastic Card Encoding App Using a Sandbox Workspace](./#develop-a-plastic-card-encoding-app-using-a-sandbox-workspace) + * [Launch Your Visionline Plastic Card Encoding App](./#launch-your-visionline-plastic-card-encoding-app-to-a-live-visionline-system) +* [Developing and Launching a Mobile Key Solution](./#developing-and-launching-a-mobile-key-solution) + * [Develop Your Visionline Mobile Key App](./#develop-your-visionline-mobile-key-app) + * [Launch Your Visionline Mobile Key App](./#launch-your-visionline-mobile-key-app) + +*** + +## Developing and Launching a Plastic Card Encoding Solution + +The following sections describe the major steps of the setup process for developing and launching a plastic card encoding solution: + +### Develop a Plastic Card Encoding App Using a Real Visionline Server + +1. Install your Visionline application using your development account. + + Contact Seam at [support@seam.co](mailto:support@seam.co) to obtain access. +2. Configure Visionline and set it up to work with plastic cards. + 1. Unblock the required ports. + 2. Make sure that Visionline is configured with an appropriate user account. + 3. Buy and install a [Visionline card encoder](https://estore.assaabloyglobalsolutions.com/no/marine/rfid-encoder-updater-complete.html) and then connect it to your Visionline server. + 4. Set up all door locks. + 5. Use Lock Service 3G to program the door locks. +3. Create a Seam production workspace. + + You can continue to use this workspace in your production phase as well. +4. Connect your Visionline development account to Seam. + + This step includes installing and running Seam Bridge to connect your on-premises Visionline application to Seam. + +For detailed instructions, see [Developing Your Visionline Plastic Card Encoding App Using a Real Visionline Server](developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/). + +*** + +### Develop a Plastic Card Encoding App Using a Sandbox Workspace + +1. Create a sandbox workspace.\ + A sandbox workspace enables you to develop and test your app using Seam-provided virtual systems and devices. +2. Connect the virtual Visionline ACS to Seam. + +For detailed instructions, see [Developing Your Visionline Plastic Card Encoding App Using a Sandbox Workspace](developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/). + +*** + +### Launch Your Visionline Plastic Card Encoding App to a Live Visionline System + +1. Confirm that your production Visionline site meets the system requirements. +2. Make sure that Visionline is configured with an appropriate user account. +3. Purchase the required Callback option from ASSA ABLOY and import it into Visionline. +4. Connect your Visionline production account to Seam. + + Either create a new production workspace or use your existing production workspace.\ + This step also includes installing Seam Bridge. + +For detailed instructions, see [Launching Your Visionline Plastic Card Encoding App](developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/). + +*** + +## Developing and Launching a Mobile Key Solution + +The following sections describe the major steps of the setup process for developing and launching a mobile key solution: + +### Develop Your Visionline Mobile Key App + +1. Sign up for and complete the ASSA ABLOY mobile development course. +2. Install your Visionline app. +3. Configure Visionline using your development account. + 1. Unblock the required ports. + 2. Make sure that Visionline is configured with an appropriate user account. + 3. Set up your Credential Services account in the Visionline application. + 4. Configure the mobile access UUID in the Visionline application. + 5. Set up all door locks with Bluetooth low energy (BLE) profiles. + 6. Use Lock Service 3G to program the door locks. +4. Create a Seam production workspace. + + You can continue to use this workspace in your production phase as well. +5. Connect your Visionline site to Seam using your Visionline development account. + + This step includes installing and running Seam Bridge to connect your on-premises Visionline application to Seam. + + 1. Also, add your Visionline development application ID in Seam Console. + +For detailed instructions, see [Developing Your Visionline Mobile Key App](developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/). + +*** + +### Launch Your Visionline Mobile Key App + +1. Pass the ASSA ABLOY certification process. +2. Confirm that your production Visionline site meets the system requirements. +3. Configure all door locks for use with mobile keys. + + {% hint style="info" %} + This process can be quite time-consuming because it requires interaction with all locks. + {% endhint %} + + 1. Make sure that the BLE module is installed on all locks. + 2. Set up all door locks with BLE profiles. + 3. Use Lock Service 3G to program all locks. +4. Configure Visionline using your production account. + 1. Make sure that Visionline is configured with an appropriate user account. + 2. Purchase the following required options from ASSA ABLOY and import them into Visionline: + * Callback options + * Mobile Service option with your tenant account +5. Connect your Visionline production instance to Seam. + + Either create a new production workspace or use your existing production workspace. + + This step also includes installing Seam Bridge and adding your Visionline application ID in your workspace. + +For detailed instructions, see [Launching Your Visionline Mobile Key App](developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/). From e91d1b16c61c3b6df525dfca0b8ca8463a78defe Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 22 May 2025 14:41:27 -0400 Subject: [PATCH 4/7] Update SUMMARY.md --- docs/SUMMARY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 55b1ee434..48faa0b74 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -338,7 +338,7 @@ * [Get started with 4SUITES locks](device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.md) * [Akiles Locks](device-and-system-integration-guides/akiles-locks/README.md) * [Get started with Akiles locks](device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.md) -* [ASSA ABLOY Credential Services](device-and-system-integration-guides/assa-abloy-credential-services.md) +* [ASSA ABLOY Credential Services](device-and-system-integration-guides/assa-abloy-credential-services-credential-manager.md) * [ASSA ABLOY Visionline Access Control System](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/README.md) * [Visionline ACS Setup Instructions](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/README.md) * [Developing and Launching Your Visionline Plastic Card Encoding App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/README.md) From 552aa47bc3a52f3106ad747c5fc68855f82a60e6 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam Date: Thu, 22 May 2025 15:54:48 -0400 Subject: [PATCH 5/7] Fix missing content --- docs/SUMMARY.md | 15 +- .../access-codes/creating-access-codes.md | 19 - ...-credential-services-credential-manager.md | 65 -- .../assa-abloy-credential-services.md | 63 ++ .../common-use-cases.md | 126 ++++ .../README.md | 219 +++++++ ...that-is-set-up-for-a-credential-manager.md | 31 + ...ypes-of-guest-joiner-mobile-credentials.md | 99 +++ ...rious-types-of-guest-mobile-credentials.md | 131 ++++ .../retrieving-guest-and-common-entrances.md | 69 ++ .../revoking-mobile-credentials.md | 140 ++++ .../updating-guest-mobile-credentials.md | 25 + ...ating-visionline-card-based-credentials.md | 603 ++++++++++++++++++ .../credential-types/README.md | 221 ------- ...that-is-set-up-for-a-credential-manager.md | 33 - ...ypes-of-guest-joiner-mobile-credentials.md | 101 --- ...rious-types-of-guest-mobile-credentials.md | 133 ---- .../retrieving-guest-and-common-entrances.md | 71 --- .../revoking-mobile-credentials.md | 142 ----- .../updating-guest-mobile-credentials.md | 27 - .../mobile-credential-related-properties.md | 29 + .../README.md | 131 +--- .../README.md | 25 + .../next-steps.md | 8 + ...he-assa-abloy-mobile-development-course.md | 12 + ...-visionline-development-account-to-seam.md | 2 +- ...p-2-install-your-visionline-application.md | 42 ++ .../step-3-unblock-required-ports.md | 22 + ...p-4-configure-a-visionline-user-account.md | 45 ++ ...edential-services-account-in-visionline.md | 34 + ...re-the-mobile-access-uuid-in-visionline.md | 10 + ...p-7-set-up-door-locks-with-ble-profiles.md | 104 +++ .../step-8-program-door-locks.md | 148 +++++ .../step-9-create-a-production-workspace.md | 12 + .../README.md | 33 + ...y-certification-for-your-mobile-key-app.md | 19 + ...-visionline-site-meets-the-requirements.md | 23 + .../step-3-confirm-ble-module-on-all-locks.md | 42 ++ ...p-4-set-up-door-locks-with-ble-profiles.md | 104 +++ .../step-5-program-door-locks.md | 136 ++++ ...p-6-configure-a-visionline-user-account.md | 43 ++ ...-mobile-service-options-from-assa-abloy.md | 16 + .../step-8-create-a-production-workspace.md | 14 + ...r-visionline-production-account-to-seam.md | 2 +- .../README.md | 12 + .../README.md | 25 + .../next-steps.md | 7 + ...p-1-install-your-visionline-application.md | 40 ++ .../step-2-unblock-required-ports.md | 22 + ...p-3-configure-a-visionline-user-account.md | 45 ++ ...tep-4-install-a-visionline-card-encoder.md | 47 ++ .../step-5-set-up-door-locks.md | 100 +++ .../step-6-program-door-locks.md | 143 +++++ .../step-7-create-a-production-workspace.md | 12 + ...-visionline-development-account-to-seam.md | 0 .../README.md | 7 + .../next-steps.md | 7 + .../step-1-create-a-sandbox-workspace.md | 10 + ...nect-the-virtual-visionline-acs-to-seam.md | 26 + .../README.md | 17 + ...-visionline-site-meets-the-requirements.md | 44 ++ ...p-2-configure-a-visionline-user-account.md | 43 ++ ...ort-the-callback-option-from-assa-abloy.md | 16 + .../step-4-create-a-production-workspace.md | 14 + ...r-visionline-production-account-to-seam.md | 0 65 files changed, 3082 insertions(+), 944 deletions(-) delete mode 100644 docs/capability-guides/smart-locks/access-codes/creating-access-codes.md delete mode 100644 docs/device-and-system-integration-guides/assa-abloy-credential-services-credential-manager.md delete mode 100644 docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/README.md delete mode 100644 docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/checking-if-a-user-identity-has-a-phone-that-is-set-up-for-a-credential-manager.md delete mode 100644 docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/issuing-various-types-of-guest-joiner-mobile-credentials.md delete mode 100644 docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/issuing-various-types-of-guest-mobile-credentials.md delete mode 100644 docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/retrieving-guest-and-common-entrances.md delete mode 100644 docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/revoking-mobile-credentials.md delete mode 100644 docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/updating-guest-mobile-credentials.md rename docs/device-and-system-integration-guides/{assa-abloy-visionline-access-control-system-in-development => assa-abloy-visionline-access-control-system}/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md (98%) rename docs/device-and-system-integration-guides/{assa-abloy-visionline-access-control-system-in-development => assa-abloy-visionline-access-control-system}/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md (98%) rename docs/device-and-system-integration-guides/{assa-abloy-visionline-access-control-system-in-development => assa-abloy-visionline-access-control-system}/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md (100%) rename docs/device-and-system-integration-guides/{assa-abloy-visionline-access-control-system-in-development => assa-abloy-visionline-access-control-system}/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md (100%) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 48faa0b74..7273d65d6 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -42,7 +42,8 @@ * [🔒 Smart Locks](products/smart-locks/README.md) * [Locking and Unlocking Smart Locks](products/smart-locks/lock-and-unlock.md) * [Creating and Managing Smart Lock Access Codes](products/smart-locks/access-codes/README.md) - * [Creating Access Codes](capability-guides/smart-locks/access-codes/creating-access-codes.md) + * [Creating Access Codes](capability-guides/smart-locks/access-codes/creating-access-codes/README.md) + * [Understanding Code Constraints](capability-guides/smart-locks/access-codes/creating-access-codes/understanding-code-constraints.md) * [Retrieving Access Codes](products/smart-locks/access-codes/retrieving-access-codes.md) * [Modifying Access Codes](products/smart-locks/access-codes/modifying-access-codes.md) * [Deleting Access Codes](products/smart-locks/access-codes/deleting-access-codes.md) @@ -338,7 +339,7 @@ * [Get started with 4SUITES locks](device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.md) * [Akiles Locks](device-and-system-integration-guides/akiles-locks/README.md) * [Get started with Akiles locks](device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.md) -* [ASSA ABLOY Credential Services](device-and-system-integration-guides/assa-abloy-credential-services-credential-manager.md) +* [ASSA ABLOY Credential Services](device-and-system-integration-guides/assa-abloy-credential-services.md) * [ASSA ABLOY Visionline Access Control System](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/README.md) * [Visionline ACS Setup Instructions](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/README.md) * [Developing and Launching Your Visionline Plastic Card Encoding App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/README.md) @@ -350,7 +351,7 @@ * [Step 5: Set up Door Locks](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-5-set-up-door-locks.md) * [Step 6: Program Door Locks](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-6-program-door-locks.md) * [Step 7: Create a Production Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-7-create-a-production-workspace.md) - * [Step 8: Connect Your Visionline Development Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md) + * [Step 8: Connect Your Visionline Development Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md) * [Next Steps](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/next-steps.md) * [Developing Your Visionline Plastic Card Encoding App Using a Sandbox Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/README.md) * [Step 1: Create a Sandbox Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-1-create-a-sandbox-workspace.md) @@ -361,7 +362,7 @@ * [Step 2: Configure a Visionline User Account](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-2-configure-a-visionline-user-account.md) * [Step 3: Purchase and Import the Callback Option from ASSA ABLOY](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-3-purchase-and-import-the-callback-option-from-assa-abloy.md) * [Step 4: Create a Production Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-4-create-a-production-workspace.md) - * [Step 5: Connect Your Visionline Production Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md) + * [Step 5: Connect Your Visionline Production Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md) * [Developing and Launching Your Visionline Mobile Key App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/README.md) * [Developing Your Visionline Mobile Key App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/README.md) * [Step 1: Complete the ASSA ABLOY Mobile Development Course](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-1-complete-the-assa-abloy-mobile-development-course.md) @@ -373,7 +374,7 @@ * [Step 7: Set up Door Locks with BLE Profiles](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-7-set-up-door-locks-with-ble-profiles.md) * [Step 8: Program Door Locks](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-8-program-door-locks.md) * [Step 9: Create a Production Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-9-create-a-production-workspace.md) - * [Step 10: Connect Your Visionline Development Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md) + * [Step 10: Connect Your Visionline Development Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md) * [Next Steps](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/next-steps.md) * [Launching Your Visionline Mobile Key App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/README.md) * [Step 1: Obtain ASSA ABLOY Certification for Your Mobile Key App](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-1-obtain-assa-abloy-certification-for-your-mobile-key-app.md) @@ -384,8 +385,8 @@ * [Step 6: Configure a Visionline User Account](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-6-configure-a-visionline-user-account.md) * [Step 7: Purchase and Import the Callback and Mobile Service Options from ASSA ABLOY](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-7-purchase-and-import-the-callback-and-mobile-service-options-from-assa-abloy.md) * [Step 8: Create a Production Workspace](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-8-create-a-production-workspace.md) - * [Step 9: Connect Your Visionline Production Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md) - * [Configuring Visionline Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/README.md) + * [Step 9: Connect Your Visionline Production Account to Seam](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md) + * [Configuring Visionline Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md) * [Issuing Various Types of Guest Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-mobile-credentials.md) * [Issuing Various Types of Guest Joiner Mobile Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-joiner-mobile-credentials.md) * [Retrieving Guest and Common Entrances](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/retrieving-guest-and-common-entrances.md) diff --git a/docs/capability-guides/smart-locks/access-codes/creating-access-codes.md b/docs/capability-guides/smart-locks/access-codes/creating-access-codes.md deleted file mode 100644 index 52d804053..000000000 --- a/docs/capability-guides/smart-locks/access-codes/creating-access-codes.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -description: >- - Learn how to program an access code onto a smart lock with a keypad, and - ensure the code is successfully set. -layout: - title: - visible: true - description: - visible: true - tableOfContents: - visible: true - outline: - visible: true - pagination: - visible: true ---- - -# Creating Access Codes - diff --git a/docs/device-and-system-integration-guides/assa-abloy-credential-services-credential-manager.md b/docs/device-and-system-integration-guides/assa-abloy-credential-services-credential-manager.md deleted file mode 100644 index 9dd013fc6..000000000 --- a/docs/device-and-system-integration-guides/assa-abloy-credential-services-credential-manager.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -description: Guide for using ASSA ABLOY Credential Services with Seam ---- - -# ASSA ABLOY Credential Services - -ASSA ABLOY Credential Services stores all the mobile credentials that your application issues. To add mobile key support for your [Visionline ACS](assa-abloy-visionline-access-control-system/), you must obtain an ASSA ABLOY Credential Services account. You must also register for the ASSA ABLOY partnership program by sending an email to either of the following addresses: - -* [mobile.access.globalsolutions@assaabloy.com](mailto:mobile.access.globalsolutions@assaabloy.com) -* [onboardingprogram@assaabloy.com](mailto:onboardingprogram@assaabloy.com) - -## Before You Begin - -Before connecting your ASSA ABLOY Credential Services to Seam, you must first identify your ASSA ABLOY credentials. - -While you are in the development phase of your application, you can find your [development credentials](assa-abloy-credential-services-credential-manager.md#retrieve-your-assa-abloy-development-credentials) in the ASSA ABLOY Global Solutions Technology Partner Portal. You cannot use this preliminary application ID to connect to live sites. - -Once you have received certification through the ASSA ABLOY partnership program, ASSA ABLOY provides a set of [production credentials](assa-abloy-credential-services-credential-manager.md#retrieve-your-assa-abloy-production-credentials). - -### Retrieve Your ASSA ABLOY Development Credentials - -Locate your ASSA ABLOY tenant account username and password, as well as your Visionline system ID, application ID, and credential services URL in the ASSA ABLOY Global Solutions Technology Partner Portal. - -1. In a web browser, go to the [ASSA ABLOY Global Solutions Technology Partner Portal](https://my.assaabloyglobalsolutions.com/tpp). -2. Log in to the ASSA ABLOY Global Solutions Technology Partner Portal. -3. Click **Accounts > Account List**. - -
In the ASSA ABLOY Global Solutions Technology Partner Portal, click Accounts > Account List.
-4. In the **Agreements** area, locate and open the text (`.txt`) file.\ - This text file contains your ASSA ABLOY tenant account username and password, as well as your Visionline system ID, application ID, and credential services URL. - -### Retrieve Your ASSA ABLOY Production Credentials - -Once you have received certification, ASSA ABLOY provides your production credentials, including your application ID. - -*** - -## Setup Instructions - -1. Create and then display a [Connect Webview](../core-concepts/connect-webviews/), including `assa_abloy_credential_service` in the set of [`accepted_providers`](../api-clients/connect_webviews/#connect_webview-properties).\ - Alternately, in the top navigation pane of [Seam Console](https://console.seam.co/), click **ACS Systems**. Then, in the upper-right corner of the **Access Systems** page, click **New Access System**. - -
Click ACS Systems to go to the Access Systems page.

Click ACS Systems to go to the Access Systems page.

-2. In the Connect Webview, perform the following steps: - 1. Click **Continue**. - 2. If the Connect Webview displays multiple brand options, select **Assa Abloy Credential Service**. - 3. In the **Username** field, type your tenant account username. - 4. In the **Password** field, type your tenant account password. - 5. In the **Credential Services URL** field, type the credential services URL. - -
- 6. Click **Submit**. -3. If you are developing a custom mobile app, configure your ASSA ABLOY settings in Seam Console, as follows: - 1. In the top navigation pane of [Seam Console](https://console.seam.co/), click **Settings**. - 2. On the **Workspace Settings** page, next to **Assa Abloy Settings**, click **Edit**. - 3. In the **Assa Abloy Settings** dialog, type your application ID. - - ASSA ABLOY assigns this application ID to your app when you receive certification. This single application ID uniquely identifies your application within both the iOS and Android app stores. - -
Type your ASSA ABLOY application ID.

Type your ASSA ABLOY application ID.

- 4. Click **Save**. - -{% hint style="info" %} -ASSA ABLOY assigns you a preliminary application ID during the development phase. You cannot use this preliminary application ID to connect to live sites. After you receive certification, ASSA ABLOY provides a production application ID that you can use to connect to real sites. Consequently, when you obtain certification, you must edit your workspace settings to update this application ID. -{% endhint %} diff --git a/docs/device-and-system-integration-guides/assa-abloy-credential-services.md b/docs/device-and-system-integration-guides/assa-abloy-credential-services.md index 43b7da311..9dd013fc6 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-credential-services.md +++ b/docs/device-and-system-integration-guides/assa-abloy-credential-services.md @@ -1,2 +1,65 @@ +--- +description: Guide for using ASSA ABLOY Credential Services with Seam +--- + # ASSA ABLOY Credential Services +ASSA ABLOY Credential Services stores all the mobile credentials that your application issues. To add mobile key support for your [Visionline ACS](assa-abloy-visionline-access-control-system/), you must obtain an ASSA ABLOY Credential Services account. You must also register for the ASSA ABLOY partnership program by sending an email to either of the following addresses: + +* [mobile.access.globalsolutions@assaabloy.com](mailto:mobile.access.globalsolutions@assaabloy.com) +* [onboardingprogram@assaabloy.com](mailto:onboardingprogram@assaabloy.com) + +## Before You Begin + +Before connecting your ASSA ABLOY Credential Services to Seam, you must first identify your ASSA ABLOY credentials. + +While you are in the development phase of your application, you can find your [development credentials](assa-abloy-credential-services-credential-manager.md#retrieve-your-assa-abloy-development-credentials) in the ASSA ABLOY Global Solutions Technology Partner Portal. You cannot use this preliminary application ID to connect to live sites. + +Once you have received certification through the ASSA ABLOY partnership program, ASSA ABLOY provides a set of [production credentials](assa-abloy-credential-services-credential-manager.md#retrieve-your-assa-abloy-production-credentials). + +### Retrieve Your ASSA ABLOY Development Credentials + +Locate your ASSA ABLOY tenant account username and password, as well as your Visionline system ID, application ID, and credential services URL in the ASSA ABLOY Global Solutions Technology Partner Portal. + +1. In a web browser, go to the [ASSA ABLOY Global Solutions Technology Partner Portal](https://my.assaabloyglobalsolutions.com/tpp). +2. Log in to the ASSA ABLOY Global Solutions Technology Partner Portal. +3. Click **Accounts > Account List**. + +
In the ASSA ABLOY Global Solutions Technology Partner Portal, click Accounts > Account List.
+4. In the **Agreements** area, locate and open the text (`.txt`) file.\ + This text file contains your ASSA ABLOY tenant account username and password, as well as your Visionline system ID, application ID, and credential services URL. + +### Retrieve Your ASSA ABLOY Production Credentials + +Once you have received certification, ASSA ABLOY provides your production credentials, including your application ID. + +*** + +## Setup Instructions + +1. Create and then display a [Connect Webview](../core-concepts/connect-webviews/), including `assa_abloy_credential_service` in the set of [`accepted_providers`](../api-clients/connect_webviews/#connect_webview-properties).\ + Alternately, in the top navigation pane of [Seam Console](https://console.seam.co/), click **ACS Systems**. Then, in the upper-right corner of the **Access Systems** page, click **New Access System**. + +
Click ACS Systems to go to the Access Systems page.

Click ACS Systems to go to the Access Systems page.

+2. In the Connect Webview, perform the following steps: + 1. Click **Continue**. + 2. If the Connect Webview displays multiple brand options, select **Assa Abloy Credential Service**. + 3. In the **Username** field, type your tenant account username. + 4. In the **Password** field, type your tenant account password. + 5. In the **Credential Services URL** field, type the credential services URL. + +
+ 6. Click **Submit**. +3. If you are developing a custom mobile app, configure your ASSA ABLOY settings in Seam Console, as follows: + 1. In the top navigation pane of [Seam Console](https://console.seam.co/), click **Settings**. + 2. On the **Workspace Settings** page, next to **Assa Abloy Settings**, click **Edit**. + 3. In the **Assa Abloy Settings** dialog, type your application ID. + + ASSA ABLOY assigns this application ID to your app when you receive certification. This single application ID uniquely identifies your application within both the iOS and Android app stores. + +
Type your ASSA ABLOY application ID.

Type your ASSA ABLOY application ID.

+ 4. Click **Save**. + +{% hint style="info" %} +ASSA ABLOY assigns you a preliminary application ID during the development phase. You cannot use this preliminary application ID to connect to live sites. After you receive certification, ASSA ABLOY provides a production application ID that you can use to connect to real sites. Consequently, when you obtain certification, you must edit your workspace settings to update this application ID. +{% endhint %} diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/common-use-cases.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/common-use-cases.md index 73bc4785b..f623467b4 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/common-use-cases.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/common-use-cases.md @@ -6,3 +6,129 @@ description: >- # Common Use Cases +When integrating with the Visionline system, ASSA ABLOY requires handling a set of common scenarios to meet their integration requirements. Learn how to accomplish some of these key scenarios. + +## Issue Guest Mobile Credentials + +* [Issue a credential for a single guest in a single room.](credential-types/issuing-various-types-of-guest-mobile-credentials.md#single-guest-in-a-single-room) +* [Issue a credential for a returning guest to a single room.](credential-types/issuing-various-types-of-guest-mobile-credentials.md#returning-guest-to-a-single-room) +* [Issue credentials for multiple guests in multiple rooms.](credential-types/issuing-various-types-of-guest-mobile-credentials.md#multiple-guests-in-multiple-rooms) + +```python +acs_user = seam.acs.user.get(acs_user_id="xxx") + +new_guest_room = seam.acs.entrances.list( + acs_system_id=hotel_acs_system_id +)[0] + +seam.acs.credentials.create( + acs_user_id=acs_user.acs_user_id + credential_manager_acs_system_id="xxx" + is_multi_phone_sync_credential=True, + access_method="mobile_key", + starts_at="2023-01-01 10:40:00.000", + ends_at="2023-01-04 10:40:00.000", + allowed_acs_entrance_ids=[ + new_guest_room.acs_entrance_id, + main_entrance.acs_entrance_id + ], + visionline_metadata={ + "cardFormat": "rfid48", + "cardType": "guest", + "label": "%ROOMNUM% - %SITENAME%", + "is_override_key": True + } +) +``` + +```python +guest_room_1 = seam.acs.entrances.list( + acs_system_id=hotel_acs_system_id +)[0] + +guest_room_2 = seam.acs.entrances.list( + acs_system_id=hotel_acs_system_id +)[0] + +first_acs_user = seam.acs.user.get(acs_user_id="xxx") + +# First credential should be an override credential. +first_credential = seam.acs.credentials.create( + acs_user_id=first_acs_user.acs_user_id + credential_manager_acs_system_id="xxx" + is_multi_phone_sync_credential=True, + access_method="mobile_key", + starts_at="2023-01-01 10:40:00.000", + ends_at="2023-01-04 10:40:00.000", + allowed_acs_entrance_ids=[ + guest_room_1.acs_entrance_id, + guest_room_2.acs_entrance_id, + main_entrance.acs_entrance_id + ], + visionline_metadata={ + "cardFormat": "rfid48", + "cardType": "guest", + "label": "%ROOMNUM% - %SITENAME%", + "is_override_key": True + } +) + +second_acs_user = seam.acs.user.get(acs_user_id="yyy") + +# Subsequent credentials should be joiners to the first credential. +seam.acs.credentials.create( + acs_user_id=second_acs_user.acs_user_id + credential_manager_acs_system_id="xxx" + is_multi_phone_sync_credential=True, + access_method="mobile_key", + starts_at="2023-01-01 10:40:00.000", + ends_at="2023-01-04 10:40:00.000", + allowed_acs_entrance_ids=[ + guest_room_1.acs_entrance_id, + guest_room_2.acs_entrance_id, + main_entrance.acs_entrance_id + ], + visionline_metadata={ + "cardFormat": "rfid48", + "cardType": "guest", + "label": "%ROOMNUM% - %SITENAME%", + "joiner_acs_credential_ids": [first_credential.acs_credential_id] + } +) +``` + +*** + +## Issue Joiner Mobile Credentials + +* [Join to a Seam mobile credential.](credential-types/issuing-various-types-of-guest-joiner-mobile-credentials.md#join-to-a-seam-mobile-credential) +* [Join to a plastic card.](credential-types/issuing-various-types-of-guest-joiner-mobile-credentials.md#join-to-a-plastic-card) + +```python +joiners = [joiner_mobile_parent_sync_credential, joiner_mobile_child_credential] + +# Create the mobile credential. +cred = seam.acs.credentials.create({ + acs_user_id: "xxx", + credential_manager_acs_system_id="xxs" + is_multi_phone_sync_credential: True, + access_method = "mobile_key", + starts_at: "2023-01-01 10:40:00.000", + ends_at: "2023-01-04 10:40:00.000", + visionline_metadata: { + "cardFormat": "rfid48", + "label": "%ROOMNUM% - %SITENAME%", + "joiner_acs_credential_ids": [ + joiner.acs_credential_id for joiner in joiners + ] + } +}) +``` + +*** + +## Additional Scenarios + +* [Update guest mobile credentials.](credential-types/updating-guest-mobile-credentials.md) +* [Revoke a mobile credential.](credential-types/revoking-mobile-credentials.md) +* [Remove a user identity.](../../api/user_identities/delete.md) \ No newline at end of file diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md index de0938aec..95f3bda8f 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md @@ -1,2 +1,221 @@ +--- +description: Learn how to configure Visionline mobile credentials. +--- + # Configuring Visionline Mobile Credentials +In the ASSA ABLOY Visionline Access Management System, locks are standalone and battery-powered. All access permissions and scheduling details are contained within the key cards and mobile credentials, characterizing these systems as "data-on-card" systems. + +This guide describes how to issue guest and staff mobile credentials on the Visionline ACS. + +## Access Permission Assignment for Visionline + +Visionline is a [credential-based access control system](../../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#credential-based-access-control-systems). That is, you create ACS users and credentials. Within these credentials, you specify the set of entrances to which you want to grant access and the schedules for this access. + +
Seam resource relationships for a credential-based ACS

Seam resource relationships for a credential-based ACS

+ +### Credential Types for Visionline + +When creating credentials, you can configure [guest](./#issuing-guest-mobile-credentials) mobile credentials for a Visionline ACS. Guest credentials are further subdivided into [override](./#issue-the-first-credential-for-a-reservation) and [joiner](./#issue-subsequent-credentials-for-a-reservation) credentials. An override credential serves as the first access grant for a reservation and revokes all previous guest access to the included guest room entrances. When a reservation includes multiple guests who need access, all subsequent access grants for the same reservation are joiner credentials. This type of credential provides shared access that matches the grants of existing credentials. For more details, see the following sections: + +* [Guest Mobile Credential Types](./#guest-mobile-credential-types) +* [Issue the First Credential for a Reservation](./#issue-the-first-credential-for-a-reservation) +* [Issue Subsequent Credentials for a Reservation](./#issue-subsequent-credentials-for-a-reservation) + +{% hint style="info" %} +Seam currently only supports issuing guest mobile credentials and plastic cards. +{% endhint %} + +### Access Grant Process for Visionline + +Use the following basic process to grant access in a Visionline ACS: + +1. Set up the mobile user account by creating a [user identity](../../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity). +2. Turn on the [enrollment automation](../../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md) for this user identity and credential manager. +3. Associate the user identity with an [ACS user](../../../products/access-systems/#what-is-a-user). +4. Gather the entrances to which the credential should have access. +5. Create the [guest](./#issuing-guest-mobile-credentials) mobile credential. + +*** + +## Issuing Guest Mobile Credentials + +To issue a guest mobile credential for the Visionline ACS, create a credential with `visionline_metadata.card_function_type` set to `guest`. Also, for a guest credential, you normally set `visionline_metadata.card_format` to `rfid48`, unless the guest needs a higher-capacity `TLCode` card. For more information about Visionline metadata, see [`acs_credential.visionline_metadata` Properties](../mobile-credential-related-properties.md#acs_credential.visionline_metadata-properties). + +### Guest Mobile Credential Types + +Guest mobile credentials consist of two credential types: override credentials and joiner credentials. + +When issuing the [first guest credential for a reservation](./#issue-the-first-credential-for-a-reservation), a hotel needs to guarantee that all previous access to the guest room entrance is revoked. To revoke all other access, you create an override credential that invalidates all previous access to the guest room entrance. That is, an override credential overrides any existing credentials that previously granted access to the same guest room entrance. + +Reservations may involve multiple parties. In these situations, hotels often need to provide credentials for the same guest room entrances to additional guests. To do so, [issue "joiner credentials."](./#issue-subsequent-credentials-for-a-reservation) This type of credential allows shared access with any existing credentials that already grant entry to the same guest room entrances. + +*** + +### Issue the First Credential for a Reservation + +To issue the first guest credential for a reservation, create an override credential. This credential type invalidates any existing guest access to the target entrances. When creating an override credential, set `visionline_metadata.override` to `true`. + +{% hint style="info" %} +You can also [verify whether a user identity has a phone that is set up for a credential manager](checking-if-a-user-identity-has-a-phone-that-is-set-up-for-a-credential-manager.md) and, consequently, is ready to accept an override guest credential. +{% endhint %} + +{% tabs %} +{% tab title="Python" %} +```python +# Set up the mobile user account. +user_identity = seam.user_identities.create( + user_identity_key="xxx" +) + +# Turn on the enrollment automation for this user identity +# and credential manager. +seam.enrollment_automation.launch( + credential_manager_acs_system_id=assa_credential_services.acs_system_id, + user_identity_id=guest_user_identity.user_identity_id, + create_credential_manager_user=True +) + +# Associate the user identity with the ACS user. +acs_user = seam.acs.users.get( + email="jane@example.com" +) +seam.user_identities.add_acs_user( + user_identity=user_identity.user_identity_id, + acs_user_id=acs_user.acs_user_id +) + +# Gather entrances to which the credential should have access. +room_entrance = seam.acs.entrances.get(name=f"Room {room_number}") +common_door = seam.acs.entrances.get(name=f"Main Entrance") + +# Check whether the user identity has an active endpoint on their phones. +# To learn how to verify this condition, see "Check if a user identity has +# a phone that is set up for a credential manager." +if has_active_endpoint(user_identity.user_identity_id): + # Create the override mobile credential. + cred = seam.acs.credentials.create( + acs_user_id="xxx", + credential_manager_acs_system_id="xx" + is_multi_phone_sync_credential=True, + access_method="mobile_key", + starts_at="2023-01-01 10:40:00.000", + ends_at="2023-01-04 10:40:00.000" + allowed_acs_entrance_ids=[ + room_entrance.acs_entrance_id, + common_door.acs_entrance_id + ], + visionline_metadata={ + "cardFormat": "rfid48", + "label": "%ROOMNUM% - %SITENAME%", + "override": True + } +) +``` +{% endtab %} +{% endtabs %} + +*** + +### Issue Subsequent Credentials for a Reservation + +Once you have created an override mobile credential as the first credential for a reservation, you can issue mobile credentials to additional guests on the same reservation. To do so, issue "joiner credentials." This type of credential allows shared access with any existing credentials that already grant entry to the same guest room entrances. Note that you can create joiner mobile credentials that provide access to guest room entrances, common entrances, or both. + +For example: + +* You already created an override mobile credential to grant a guest access to hotel rooms 101 and 102. Now, you create a joiner mobile credential that grants a different guest on the same reservation access to the same two hotel rooms. +* You already created an override mobile credential to grant a guest access to hotel rooms 101 and 102. Now, you create a joiner mobile credential that grants a different guest on the same reservation access to hotel room 101 only. + +To issue a joiner credential, you must specify both the entrances to which to grant access and the credentials with which to associate the new joiner credential. Use the following properties: + +* `allowed_acs_entrance_ids` +* `visionline_metadata.joiner_acs_credential_ids` + +For instructions on how to retrieve credentials that have overlapping access, see [Issuing Various Types of Guest Joiner Mobile Credentials](issuing-various-types-of-guest-joiner-mobile-credentials.md). + +{% tabs %} +{% tab title="Python" %} +```python +# Set up the mobile user account. +user_identity = seam.user_identities.create( + user_identity_key="xxx" +) + +# Turn on the enrollment automation for this user identity +# and credential manager. +seam.enrollment_automation.launch( + credential_manager_acs_system_id=assa_credential_services.acs_system_id, + user_identity_id=guest_user_identity.user_identity_id, + create_credential_manager_user: true +) + +# Associate the user identity with the ACS user. +acs_user = seam.acs.users.get( + email="jane@example.com" +) +seam.user_identities.add_acs_user( + user_identity=user_identity.user_identity_id, + acs_user_id=acs_user.acs_user_id +) + +# Gather entrances to which the credential should have access. +room_entrance = seam.acs.entrances.get(name=f"Room {room_number}") +common_door = seam.acs.entrances.get(name=f"Main Entrance") + +# Retrieve existing valid credentials for guest doors to add as joiners. +# Be sure to check that these credentials correspond with the correct +# reservation. +joiner1 = seam.acs.credentials.get(id="xxx") +joiner2 = seam.acs.credentials.get(id="yyy") +joiners = [joiner1, joiner2] + +# Create the mobile credential. +cred = seam.acs.credentials.create({ + acs_user_id: "xxx", + credential_manager_acs_system_id="xxs" + is_multi_phone_sync_credential: True, + access_method = "mobile_key", + starts_at: "2023-01-01 10:40:00.000", + ends_at: "2023-01-04 10:40:00.000", + allowed_acs_entrance_ids: [ + common_door.acs_entrance_id, + room_entrance.acs_entrance_id + ], + visionline_metadata: { + "cardFormat": "rfid48", + "label": "%ROOMNUM% - %SITENAME%", + "joiner_acs_credential_ids": [ + joiner['acs_credential_id'] for joiner in joiners + ] + } +}) +``` +{% endtab %} +{% endtabs %} + +{% tabs %} +{% tab title="Python" %} +```python +all_entrances = seam.acs.entrances.list( + acs_system_id=acs_system.acs_system_id +) + +# Filter for entrances with the common entrance category types. +common_entrance_category_types = ["common", "common (PMS)"] + +def filter_entrances_by_profile_type(entrance_list, category_types): + common_entrances = [] + for entrance in entrance_list: + if entrance["visionline_metadata"]["door_category"] in category_types: + common_entrances.append(entrance) + return common_entrances + +common_entrances = filter_entrances_by_profile_type( + all_entrances, + common_entrance_category_types +) +``` +{% endtab %} +{% endtabs %} + +
In the Seam Console, we disable the Override option when a user identity has not set up their phone to receive Visionline credentials.

In the Seam Console, we disable the Override option when a user identity has not set up their phone to receive Visionline credentials.

diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/checking-if-a-user-identity-has-a-phone-that-is-set-up-for-a-credential-manager.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/checking-if-a-user-identity-has-a-phone-that-is-set-up-for-a-credential-manager.md index 2e6b57fc9..33169c15f 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/checking-if-a-user-identity-has-a-phone-that-is-set-up-for-a-credential-manager.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/checking-if-a-user-identity-has-a-phone-that-is-set-up-for-a-credential-manager.md @@ -1,2 +1,33 @@ +--- +description: >- + Learn how to determine when your app should disable the override credential + option for guest credentials. +--- + # Checking if a User Identity Has a Phone That Is Set up for a Credential Manager +To issue an [override guest credential](./#issue-the-first-credential-for-a-reservation) to an app user, the app user must first set up their phone. If you want to disable the "override" option where it's not available, you can use the following check before allowing a user to configure an override credential: + +{% tabs %} +{% tab title="Python" %} +``` +def has_active_endpoint(user_identity_id): + phones = seam.phones.list({ + owner_user_identity_id=user_identity_id + }) + for phone in phones: + metadata = phone.get('assa_abloy_credential_service_metadata', {}) + if metadata.get('has_active_endpoint'): + return True + return False + +# Check if any phone has an active endpoint. +user_identity = seam.user_identities.get(phone_number="1234567890") +active_endpoint_exists = has_active_endpoint(user_identity.user_identity_id) +``` +{% endtab %} +{% endtabs %} + +## Example of Disabling the Override Option When It's Not Available + +
In the Seam Console, we disable the Override option when a user identity has not set up their phone to receive Visionline credentials.

In the Seam Console, we disable the Override option when a user identity has not set up their phone to receive Visionline credentials.

diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-joiner-mobile-credentials.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-joiner-mobile-credentials.md index 376deff36..a2e47bd49 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-joiner-mobile-credentials.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-joiner-mobile-credentials.md @@ -1,2 +1,101 @@ +--- +description: Learn how to issue guest joiner credentials of various types. +--- + # Issuing Various Types of Guest Joiner Mobile Credentials +In addition to understanding the [basic process for issuing guest joiner credentials](./#issue-subsequent-credentials-for-a-reservation), it is useful to know how to issue various specific types of guest joiner credentials. + +## Before You Begin + +To issue a [joiner credential](./#issue-subsequent-credentials-for-a-reservation), you must specify the guest door credentials with which to associate the new joiner credential. To identify and retrieve these existing valid credentials, use the following process: + +1. Identify the guest entrances to which you want to issue the joiner credential. +2. Retrieve the existing guest credentials that have been issued for these guest entrances. +3. Issue the joiner credential and include these guest credentials as joiners. + +{% tabs %} +{% tab title="Python" %} +```python +# Define the list of guest entrances to check. +guest_entrance_ids = [ + room_101.acs_entrance_id, + room_102.acs_entrance_id, +] + +# Initialize a list to hold credentials for each entrance. +all_credentials = [] + +# Retrieve all valid credentials for each entrance individually. +for entrance_id in guest_entrance_ids: + credentials = seam.acs.entrances.list_credentials_with_access( + acs_entrance_id=entrance_id, + include_if=["visionline_metadata.is_valid"] + ) + all_credentials.append({ + "entrance_id": entrance_id, + "credentials": credentials + }) +``` +{% endtab %} +{% endtabs %} + +*** + +## Join to a Seam Mobile Credential + +You can select either the multi-phone sync credential or the child credentials. Make sure to get the `acs_credential_id` to include in the `joiner_acs_credential_ids` list. + +```python +joiners = [joiner_mobile_parent_sync_credential, joiner_mobile_child_credential] + +# Create the mobile credential. +cred = seam.acs.credentials.create({ + acs_user_id: "xxx", + credential_manager_acs_system_id="xxs" + is_multi_phone_sync_credential: True, + access_method = "mobile_key", + allowed_acs_entrance_ids=[ + "xxxx" + ], + starts_at: "2023-01-01 10:40:00.000", + ends_at: "2023-01-04 10:40:00.000", + visionline_metadata: { + "cardFormat": "rfid48", + "label": "%ROOMNUM% - %SITENAME%", + "joiner_acs_credential_ids": [ + joiner.acs_credential_id for joiner in joiners + ] + } +}) +``` + +*** + +## Join to a Plastic Card + +You can join to a plastic card. + +```python +joiners = [joiner_plastic_card_credential] + +# Create the mobile credential. +cred = seam.acs.credentials.create({ + acs_user_id: "xxx", + credential_manager_acs_system_id="xxs" + is_multi_phone_sync_credential: True, + access_method = "mobile_key", + allowed_acs_entrance_ids=[ + "xxxx" + ] + starts_at: "2023-01-01 10:40:00.000", + ends_at: "2023-01-04 10:40:00.000", + visionline_metadata: { + "cardFormat": "rfid48", + "label": "%ROOMNUM% - %SITENAME%", + "joiner_acs_credential_ids": [ + joiner.acs_credential_id for joiner in joiners + ] + } +}) +``` diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-mobile-credentials.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-mobile-credentials.md index 3939dca17..30c32639f 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-mobile-credentials.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/issuing-various-types-of-guest-mobile-credentials.md @@ -1,2 +1,133 @@ +--- +description: Learn how to issue guest mobile credentials of various types. +--- + # Issuing Various Types of Guest Mobile Credentials +In addition to understanding the [basic process for issuing guest mobile credentials](./#issuing-guest-mobile-credentials), it is useful to know how to issue guest mobile credentials of various types. + +## Single Guest in a Single Room + +To issue a credential for a single guest in a single room, create an [override guest credential](./#issue-the-first-credential-for-a-reservation). + +```python +acs_user = seam.acs.user.get(acs_user_id="xxx") + +guest_room = seam.acs.entrances.list( + acs_system_id=hotel_acs_system_id +)[0] + +seam.acs.credentials.create( + acs_user_id=acs_user.acs_user_id + credential_manager_acs_system_id="xxx" + is_multi_phone_sync_credential=True, + access_method="mobile_key", + starts_at="2023-01-01 10:40:00.000", + ends_at="2023-01-04 10:40:00.000", + allowed_acs_entrance_ids=[ + guest_room.acs_entrance_id, + main_entrance.acs_entrance_id + ], + visionline_metadata={ + "cardFormat": "rfid48", + "cardType": "guest", + "label": "%ROOMNUM% - %SITENAME%", + "override": True + } +) +``` + +*** + +## Returning Guest to a Single Room + +A new mobile key automatically overrides a previously-issued mobile credential. + +```python +acs_user = seam.acs.user.get(acs_user_id="xxx") + +new_guest_room = seam.acs.entrances.list( + acs_system_id=hotel_acs_system_id +)[0] + +seam.acs.credentials.create( + acs_user_id=acs_user.acs_user_id + credential_manager_acs_system_id="xxx" + is_multi_phone_sync_credential=True, + access_method="mobile_key", + starts_at="2023-01-01 10:40:00.000", + ends_at="2023-01-04 10:40:00.000", + allowed_acs_entrance_ids=[ + new_guest_room.acs_entrance_id, + main_entrance.acs_entrance_id + ], + visionline_metadata={ + "cardFormat": "rfid48", + "cardType": "guest", + "label": "%ROOMNUM% - %SITENAME%", + "override": True + } +) +``` + +*** + +## Multiple Guests in Multiple Rooms + +To issue credentials for multiple guests in multiple rooms, first create an [override guest credential](./#issue-the-first-credential-for-a-reservation). Then, create all subsequent guest credentials as [joiners](./#issue-subsequent-credentials-for-a-reservation). + +```python +guest_room_1 = seam.acs.entrances.list( + acs_system_id=hotel_acs_system_id +)[0] + +guest_room_2 = seam.acs.entrances.list( + acs_system_id=hotel_acs_system_id +)[0] + +first_acs_user = seam.acs.user.get(acs_user_id="xxx") + +# First credential should be an override credential. +first_credential = seam.acs.credentials.create( + acs_user_id=first_acs_user.acs_user_id + credential_manager_acs_system_id="xxx" + is_multi_phone_sync_credential=True, + access_method="mobile_key", + starts_at="2023-01-01 10:40:00.000", + ends_at="2023-01-04 10:40:00.000", + allowed_acs_entrance_ids=[ + guest_room_1.acs_entrance_id, + guest_room_2.acs_entrance_id, + main_entrance.acs_entrance_id + ], + visionline_metadata={ + "cardFormat": "rfid48", + "cardType": "guest", + "label": "%ROOMNUM% - %SITENAME%", + "override": True + } +) + +second_acs_user = seam.acs.user.get(acs_user_id="yyy") + +# Subsequent credentials should be joiners to the first credential. +seam.acs.credentials.create( + acs_user_id=second_acs_user.acs_user_id + credential_manager_acs_system_id="xxx" + is_multi_phone_sync_credential=True, + access_method="mobile_key", + starts_at="2023-01-01 10:40:00.000", + ends_at="2023-01-04 10:40:00.000", + allowed_acs_entrance_ids=[ + guest_room_1.acs_entrance_id, + guest_room_2.acs_entrance_id, + main_entrance.acs_entrance_id + ], + visionline_metadata={ + "cardFormat": "rfid48", + "cardType": "guest", + "label": "%ROOMNUM% - %SITENAME%", + "joiner_acs_credential_ids": [first_credential.acs_credential_id] + } +) +``` diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/retrieving-guest-and-common-entrances.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/retrieving-guest-and-common-entrances.md index d8ae163fc..3f6e5af9a 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/retrieving-guest-and-common-entrances.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/retrieving-guest-and-common-entrances.md @@ -1,2 +1,71 @@ +--- +description: >- + Learn how to fetch various types of entrances to help provide more context for + your app users. +--- + # Retrieving Guest and Common Entrances +You can retrieve lists of entrances. You may want to display entrances categorized by type to provide more context to your app users. To fetch only guest or common entrances, filter using the `visionline_metadata.door_category` property for entrances. The value for this property is set within the Visionline ACS. + +
You can provide context to your app users by displaying entrances categorized by type.

You can provide context to your app users by displaying entrances categorized by type.

+ +## Fetch Guest Entrances + +To fetch only guest entrances, filter entrances to include only those with a `visionline_metadata.properties.door_category` of `guest`. + +{% tabs %} +{% tab title="Python" %} +```python +all_entrances = seam.acs.entrances.list( + acs_system_id=acs_system.acs_system_id +) + +# Filter for entrances with the guest entrance category type. +guest_entrance_category_types = ["guest"] + +def filter_entrances_by_profile_type(entrance_list, category_types): + guest_entrances = [] + for entrance in entrance_list: + if entrance["visionline_metadata"]["door_category"] in category_types: + guest_entrances.append(entrance) + return guest_entrances + +guest_entrances = filter_entrances_by_profile_type( + all_entrances, + guest_entrance_category_types +) +``` +{% endtab %} +{% endtabs %} + +*** + +## Fetch Common Entrances + +To fetch only common entrances, filter entrances to include only those with a `visionline_metadata.properties.door_category` of `common` or `common (PMS)`. + +{% tabs %} +{% tab title="Python" %} +```python +all_entrances = seam.acs.entrances.list( + acs_system_id=acs_system.acs_system_id +) + +# Filter for entrances with the common entrance category types. +common_entrance_category_types = ["common", "common (PMS)"] + +def filter_entrances_by_profile_type(entrance_list, category_types): + common_entrances = [] + for entrance in entrance_list: + if entrance["visionline_metadata"]["door_category"] in category_types: + common_entrances.append(entrance) + return common_entrances + +common_entrances = filter_entrances_by_profile_type( + all_entrances, + common_entrance_category_types +) +``` +{% endtab %} +{% endtabs %} diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/revoking-mobile-credentials.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/revoking-mobile-credentials.md index e80047f57..5a6b241b2 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/revoking-mobile-credentials.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/revoking-mobile-credentials.md @@ -1,2 +1,142 @@ +--- +description: Learn how to delete mobile credentials. +--- + # Revoking Mobile Credentials +To revoke a mobile credential, [delete the credential](../../../capability-guides/access-systems/managing-credentials.md#delete-a-credential). Seam issues a discard command for the Visionline card. If you are deleting a [multi-phone sync credential](../../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#what-are-multi-phone-sync-credentials), Seam discards all of the credentials that were created underneath it. + +{% tabs %} +{% tab title="Python" %} +**Request:** + +```python +seam.acs.credentials.delete( + acs_credential_id="66666666-6666-6666-6666-666666666666" +) +``` + +**Response:** + +``` +None +``` +{% endtab %} + +{% tab title="cURL (bash)" %} +**Request:** + +```bash +curl -X 'POST' \ + 'https://connect.getseam.com/acs/credentials/delete' \ + -H 'accept: application/json' \ + -H "Authorization: Bearer ${API_KEY}" \ + -H 'Content-Type: application/json' \ + -d '{ + "acs_credential_id": "66666666-6666-6666-6666-666666666666" +}' +``` + +**Response:** + +```json +{ + "ok": true +} +``` +{% endtab %} + +{% tab title="JavaScript" %} +**Request:** + +```javascript +await seam.acs.credentials.delete({ + acs_credential_id: "66666666-6666-6666-6666-666666666666" +}); +``` + +**Response:** + +```json +void +``` +{% endtab %} + +{% tab title="Ruby" %} +**Request:** + +```ruby +# Coming soon! +``` + +**Response:** + +``` +# Coming soon! +``` +{% endtab %} + +{% tab title="PHP" %} +**Request:** + +```php +$seam->acs->credentials->delete( + acs_credential_id: "66666666-6666-6666-6666-666666666666" +); +``` + +**Response:** + +``` +void +``` +{% endtab %} + +{% tab title="C#" %} +**Request:** + +```csharp +seam.CredentialsAcs.Delete( + acsCredentialId: "66666666-6666-6666-6666-666666666666" +); +``` + +**Response:** + +``` +void +``` +{% endtab %} + +{% tab title="Java" %} +**Request:** + +```java +// Coming soon! +``` + +**Response:** + +```json +// Coming soon! +``` +{% endtab %} + +{% tab title="Go" %} +**Request:** + +```go +_, uErr := client.Acs.Credentials.Delete( + context.Background(), &acs.CredentialsDeleteRequest{ + acsCredentialId: "66666666-6666-6666-6666-666666666666", + }, +); +``` + +**Response:** + +```json +void +``` +{% endtab %} +{% endtabs %} diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/updating-guest-mobile-credentials.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/updating-guest-mobile-credentials.md index 7189d33a9..bf70b7ab4 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/updating-guest-mobile-credentials.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/updating-guest-mobile-credentials.md @@ -1,2 +1,27 @@ +--- +description: Learn how to update guest credentials. +--- + # Updating Guest Mobile Credentials +Instead of updating a guest credential, you can issue a new [joiner credential](./#issue-subsequent-credentials-for-a-reservation) with the updated parameters. Seam automatically replaces the old credential with the new one. + +```python +# Creating a new mobile credential automatically revokes +# the previous one. +seam.acs.credentials.create({ + acs_user_id: "xxx", + credential_manager_acs_system_id="xxx" + is_multi_phone_sync_credential: True, + access_method = "mobile_key", + starts_at: "2023-01-01 10:40:00.000", + ends_at: "2023-01-04 10:40:00.000", + visionline_metadata: { + "cardFormat": "rfid48", + "label": "%ROOMNUM% - %SITENAME%", + "joiners": [ + "xxx", "yyy" + ] + } +}) +``` diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md index 429ab2e84..f725b8564 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md @@ -4,3 +4,606 @@ description: Learn how to create a card-based credential for Visionline. # Creating Visionline Card-based Credentials +To create a credential to encode onto a plastic key card for a Visionline ACS: + +1. Set up an [ACS user](../../products/access-systems/user-management.md). +2. Create a [credential](../../capability-guides/access-systems/managing-credentials.md#create-a-card-based-credential) with the `access_method` set to `card` and the appropriate [`visionline_metadata`](mobile-credential-related-properties.md#acs_credential.visionline_metadata-properties), such as the card format. + + * To issue the first credential for a reservation—that is, an "override" credential—make sure to set `visionline_metadata.override` to `true`. + * To issue subsequent credentials for a reservation, set the `visionline_metadata.joiner_acs_credential_ids`. + + For more information about Visionline credential types, see [Credential Types for Visionline](credential-types/#credential-types-for-visionline) and [Guest Mobile Credential Types](credential-types/#guest-mobile-credential-types). +3. Encode the credential onto a plastic card. + 1. Use the `/acs/encoders/list` endpoint to retrieve a list of available encoders. Then, choose the encoder that you want to use to write the credential to the card.\ + See [Retrieve Encoders](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md#id-2.-retrieve-encoders). + 2. Use the `/acs/encoders/encode_credential` endpoint to encode the credential onto the card, using the encoder that you have chosen.\ + See [Encode the Card](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md#id-3.-encode-the-card). + 3. Confirm that the card was encoded successfully using polling or a [webhook](../../core-concepts/webhooks.md).\ + See [Confirm Successful Encoding](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md#id-4.-confirm-successful-encoding). Also, see a list of [common encoding errors](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md#common-encoding-errors). + +The following example shows how to create a card-based override credential for Visionline and encode it onto a plastic card: + +{% tabs %} +{% tab title="Python" %} +**Code:** + +```python +# Step 1: +# Create the new ACS user. +acs_user = seam.acs.users.create( + acs_system_id = "11111111-1111-1111-1111-111111111111", + full_name = "Jane Doe", + email_address = "jane@example.com" +) + +# Step 2: +# Create a card-based credential for each entrance for the ACS user. +credential = seam.acs.credentials.create( + acs_user_id = acs_user.acs_user_id, + access_method = "card", + # List the IDs of the entrances to which + # you want to grant access. + allowed_acs_entrance_ids = [ + room_101.seam_acs_entrance_id + ], + starts_at = "2024-12-01T15:00:00.000Z", + ends_at = "2024-12-04T12:00:00.000Z", + visionline_metadata = { + "card_format": "rfid48", + "override": True + } +) + +# Step 3: +# Encode the credential onto a card. +# First, get the encoder that you want to use. +encoder = seam.acs.encoders.list( + acs_system_ids = ["11111111-1111-1111-1111-111111111111"] +)[0] + +# Then, encode the card. +encoding_action_attempt = seam.acs.encoders.encode_credential( + acs_credential_id = credential.acs_credential_id, + acs_encoder_id = encoder.acs_encoder_id +) + +# To confirm that the encoding succeeded, +# poll the returned action attempt +# until its status is success. +seam.action_attempts.get( + action_attempt_id = encoding_action_attempt.action_attempt_id +) +``` + +**Output:** + +``` +AcsCredential( + acs_credential_id='66666666-6666-6666-6666-666666666666', + acs_user_id='33333333-3333-3333-3333-333333333333', + access_method='card', + starts_at='2024-12-01T15:00:00.000Z', + ends_at='2024-12-04T12:00:00.000Z', + is_issued=False, + ... +) + +ActionAttempt( + status='success', + action_attempt_id='11111111-2222-3333-4444-555555555555', + action_type='ENCODE_CREDENTIAL', + result={ + acs_credential_id='66666666-6666-6666-6666-666666666666', + card_number='1234abc', + is_issued=True, + issued_at='2024-12-01T12:00:00.000Z', + ... + }, + error=null +) +``` +{% endtab %} + +{% tab title="cURL (bash)" %} +**Code:** + +```bash +# Step 1: +# Create the new ACS user. +acs_user=$(curl -X 'POST' \ + 'https://connect.getseam.com/acs/users/create' \ + -H 'accept: application/json' \ + -H "Authorization: Bearer ${SEAM_API_KEY}" \ + -H 'Content-Type: application/json' \ + -d "{ + \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\", + \"full_name\": \"Jane Doe\", + \"email_address\": \"jane@example.com\" +}") + +# Step 2: +# Create a card-based credential for each entrance for the ACS user. +# In allowed_entrance_ids, list the IDs of the entrances to +# which you want to grant access. +credential=$(curl -X 'POST' \ + 'https://connect.getseam.com/acs/credentials/create' \ + -H 'accept: application/json' \ + -H "Authorization: Bearer ${SEAM_API_KEY}" \ + -H 'Content-Type: application/json' \ + -d "{ + \"acs_user_id\": \"$(jq -r '.acs_user.acs_user_id' <<< ${acs_user})\", + \"access_method\": \"card\", + \"allowed_acs_entrance_ids\": [ + \"${entrance_id}\" + ], + \"starts_at\": \"2024-12-01T15:00:00.000Z\", + \"ends_at\": \"2024-12-04T12:00:00.000Z\", + \"visionline_metadata\": { + \"card_format\": \"rfid48\", + \"override\": true + } +}") + +# Step 3: +# Encode the credential onto a card. +# First, get the encoder that you want to use. +encoder=$(curl -X 'POST' \ + 'https://connect.getseam.com/acs/encoders/list' \ + -H 'accept: application/json' \ + -H "Authorization: Bearer ${SEAM_API_KEY}" \ + -H 'Content-Type: application/json' \ + -d "{ + \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\" +}" | jq -r '.acs_encoders[0]') + +# Then, encode the card. +encoding_action_attempt=$(curl -X 'POST' \ + 'https://connect.getseam.com/acs/encoders/encode_credential' \ + -H 'accept: application/json' \ + -H "Authorization: Bearer ${SEAM_API_KEY}" \ + -H 'Content-Type: application/json' \ + -d "{ + \"acs_credential_id\": \"$(jq -r '.acs_credential.acs_credential_id' <<< ${credential})\", + \"acs_encoder_id\": \"$(jq -r '.acs_encoder_id' <<< ${encoder})\" +}") + +# To confirm that the encoding succeeded, +# poll the returned action attempt +# until its status is success. +curl -X 'POST' \ + 'https://connect.getseam.com/action_attempts/get' \ + -H 'accept: application/json' \ + -H "Authorization: Bearer ${SEAM_API_KEY}" \ + -H 'Content-Type: application/json' \ + -d "{ + \"action_attempt_id\": \"$(jq -r '.action_attempt.action_attempt_id' <<< ${encoding_action_attempt})\" +}" +``` + +**Output:** + +```json +{ + "acs_credential": + { + "acs_credential_id": "66666666-6666-6666-6666-666666666666", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "access_method": "card", + "starts_at": "2024-12-01T15:00:00.000Z", + "ends_at": "2024-12-04T12:00:00.000Z", + "is_issued": false, + ... + }, + "ok":true +} + +{ + "action_attempt": + { + "status": "success", + "action_attempt_id": "11111111-2222-3333-4444-555555555555", + "action_type": "ENCODE_CREDENTIAL", + "result": { + "acs_credential_id": "66666666-6666-6666-6666-666666666666", + "card_number": "1234abc", + "is_issued": true, + "issued_at": "2024-12-01T12:00:00.000Z", + ... + }, + "error": null + }, + "ok": true +} +``` +{% endtab %} + +{% tab title="JavaScript" %} +**Code:** + +```javascript +// Step 1: +// Create the new ACS user. +const acsUser = await seam.acs.users.create({ + acs_system_id: "11111111-1111-1111-1111-111111111111", + full_name: "Jane Doe", + email_address: "jane@example.com" +}); + +// Step 2: +// Create a card-based credential for each entrance for the ACS user. +const credential = await seam.acs.credentials.create({ + acs_user_id: acsUser.acs_user_id, + access_method: "card", + allowed_acs_entrance_ids: [ + // List the IDs of the entrances to which + // you want to grant access. + room101.seam_acs_entrance_id + ], + starts_at: "2024-12-01T15:00:00.000Z", + ends_at: "2024-12-04T12:00:00.000Z", + visionline_metadata: { + "card_format": "rfid48", + "override": true + } +}); + +// Step 3: +// Encode the credential onto a card. +// First, get the encoder that you want to use. +const encoder = (await seam.acs.encoders.list({ + acs_system_ids = ["11111111-1111-1111-1111-111111111111"] +}))[0]; + +# Then, encode the card. +const encodingActionAttempt = await seam.acs.encoders.encodeCredential({ + acs_credential_id: credential.acs_credential_id, + acs_encoder_id: encoder.acs_encoder_id +}); + +# To confirm that the encoding succeeded, +# poll the returned action attempt +# until its status is success. +await seam.actionAttempts.get({ + action_attempt_id: encodingActionAttempt.action_attempt_id +}); +``` + +**Output:** + +```json +{ + acs_credential_id: '66666666-6666-6666-6666-666666666666', + acs_user_id: '33333333-3333-3333-3333-333333333333', + access_method: 'card', + starts_at: '2024-12-01T15:00:00.000Z', + ends_at: '2024-12-04T12:00:00.000Z', + is_issued: false, + ... +} + +{ + status: 'success', + action_attempt_id: '11111111-2222-3333-4444-555555555555", + action_type: 'ENCODE_CREDENTIAL', + result: { + acs_credential_id: "66666666-6666-6666-6666-666666666666', + card_number: '1234abc', + is_issued: true, + issued_at: '2024-12-01T12:00:00.000Z', + ... + }, + error: null +} +``` +{% endtab %} + +{% tab title="Ruby" %} +**Code:** + +```ruby +# Step 1: +# Create the new ACS user. +acs_user = seam.acs.users.create( + acs_system_id: "11111111-1111-1111-1111-111111111111", + full_name: "Jane Doe", + email_address: "jane@example.com" +) + +# Step 2: +# Create a card-based credential for each entrance for the ACS user. +credential = seam.acs.credentials.create( + acs_user_id: acs_user.acs_user_id, + access_method: "card", + # List the IDs of the entrances to which + # you want to grant access. + allowed_acs_entrance_ids: [ + room_101.seam_acs_entrance_id + ], + starts_at: "2024-12-01T15:00:00.000Z", + ends_at: "2024-12-04T12:00:00.000Z", + visionline_metadata: { + "card_format": "rfid48", + "override": true + } +) + +# Step 3: +# Encode the credential onto a card. +# First, get the encoder that you want to use. +encoder = (seam.acs.encoders.list( + acs_system_ids = ["11111111-1111-1111-1111-111111111111"] +))[0] + +# Then, encode the card. +encoding_action_attempt = seam.acs.encoders.encode_credential( + acs_credential_id: credential.acs_credential_id, + acs_encoder_id: encoder.acs_encoder_id +) + +# To confirm that the encoding succeeded, +# poll the returned action attempt +# until its status is success. +seam.action_attempts.get( + action_attempt_id: encoding_action_attempt.action_attempt_id +) +``` + +**Output:** + +``` + + + +``` +{% endtab %} + +{% tab title="PHP" %} +**Code:** + +```php +// Step 1: +// Create the new ACS user. +$acs_user = $seam->acs->users->create( + acs_system_id: "11111111-1111-1111-1111-111111111111", + full_name: "Jane Doe", + email_address: "jane@example.com" +); + +// Step 2: +// Create a card-based credential for each entrance for the ACS user. +$credential = $seam->acs->credentials->create( + acs_user_id: $acs_user->acs_user_id, + access_method: "card", + allowed_acs_entrance_ids: [ + // List the IDs of the entrances to which + // you want to grant access. + $room_101->seam_acs_entrance_id + ], + starts_at: "2024-12-01T15:00:00.000Z", + ends_at: "2024-12-04T12:00:00.000Z", + visionline_metadata: array('card_format' => "rfid48", 'is_override_key' => true) +); + +// Step 3: +// Encode the credential onto a card. +// First, get the encoder that you want to use. +$encoder = $seam->acs->encoders->list( + acs_system_ids = ["11111111-1111-1111-1111-111111111111"] +)[0]; + +// Then, encode the card. +$encoding_action_attempt = $seam->acs->encoders->encode_credential( + acs_credential_id: $credential->acs_credential_id, + acs_encoder_id: $encoder->acs_encoder_id +); + +// To confirm that the encoding succeeded, +// poll the returned action attempt +// until its status is success. +$seam->action_attempts->get( + action_attempt_id: $encoding_action_attempt->action_attempt_id +); +``` + +**Output:** + +```json +{ + "acs_credential_id": "66666666-6666-6666-6666-666666666666", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "access_method": "card", + "starts_at": "2024-12-01T15:00:00.000Z", + "ends_at": "2024-12-04T12:00:00.000Z", + "is_issued": false, + ... +} + +{ + "status": "success", + "action_attempt_id": "11111111-2222-3333-4444-555555555555", + "action_type": "ENCODE_CREDENTIAL", + "result": { + "acs_credential_id": "66666666-6666-6666-6666-666666666666", + "card_number": "1234abc", + "is_issued": true, + "issued_at": "2024-12-01T12:00:00.000Z", + ... + }, + "error": null +} +``` +{% endtab %} + +{% tab title="C#" %} +**Code:** + +```csharp +// Coming soon! +``` + +**Output:** + +```json +// Coming soon! +``` +{% endtab %} + +{% tab title="Java" %} +**Code:** + +```java +// Coming soon! +``` + +**Output:** + +```json +// Coming soon! +``` +{% endtab %} + +{% tab title="Go" %} +**Code:** + +```go +// Step 1: +// Create the new ACS user. +acs_user, err := client.Acs.Users.Create( + context.Background(), &acs.UsersCreateRequest{ + AcsSystemId: "11111111-1111-1111-1111-111111111111", + FullName: api.String("Jane Doe"), + EmailAddress: api.String("jane@example.com"), + }, +) +if err != nil { + return err +} + +startsAt, err := time.Parse(time.RFC3339, "2024-12-01T15:00:00Z") +endsAt, err := time.Parse(time.RFC3339, "2024-12-04T12:00:00Z") +if err != nil { + return err +} + +// Step 2: +// Create a card-based credential for each entrance for the ACS user. +credential, err := client.Acs.Credentials.Create( + context.Background(), &acs.CredentialsCreateRequest{ + AcsUserId: acs_user.AcsUserId, + AccessMethod: "card", + AllowedAcsEntranceIds: []string{ + // List the IDs of the entrances to which + // you want to grant access. + room_101.AcsEntranceId, + }, + StartsAt: api.Time(startsAt), + EndsAt: api.Time(endsAt), + VisionlineMetadata: &acs.CredentialsCreateRequestVisionlineMetadata{ + CardFormat: acs.CredentialsCreateRequestVisionlineMetadataCardFormatRfid48.Ptr(), + Override: api.Bool(true), + }, + }, +); +if err != nil { + return err +}; + +// Step 3: +// Encode the credential onto a card. +// First, get the encoder that you want to use. +encoders, err := client.Acs.Encoders.List( + context.Background(), &acs.EncodersListRequest{ + AcsSystemIds: []string{ + "11111111-1111-1111-1111-111111111111", + }, + }, +) +if err != nil { + return err +} +encoder := encoders[0] + +// Then, encode the card. +encodingActionAttempt, err := client.Acs.Encoders.EncodeCredential( + context.Background(), &acs.EncodersEncodeCredentialRequest{ + AcsCredentialId: credential.AcsCredentialId, + AcsEncoderId: encoder.AcsEncoderId, + }, +) +if err != nil { + return err +} + +// To confirm that the encoding succeeded, +// poll the returned action attempt +// until its status is success. +actionAttempt, err := client.ActionAttempts.Get( + context.Background(), &api.ActionAttemptsGetRequest{ + ActionAttemptId: encodingActionAttempt.ActionAttemptId, + }, +) +if err != nil { + return err +} + +fmt.Println(credential) +fmt.Println(actionAttempt) + +return nil +``` + +**Output:** + +```json +{ + "acs_credential_id": "66666666-6666-6666-6666-666666666666", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "access_method": "card", + "starts_at": "2024-12-01T15:00:00Z", + "ends_at": "2024-12-04T12:00:00Z", + "is_issued": false, + ... +} + +{ + "status": "success", + "action_attempt_id": "11111111-2222-3333-4444-555555555555", + "action_type": "ENCODE_CREDENTIAL", + "result": { + "acs_credential_id": "66666666-6666-6666-6666-666666666666", + "card_number": "1234abc", + "is_issued": true, + "issued_at": "2024-12-01T12:00:00.000Z", + ... + }, + "error": null +} +``` +{% endtab %} +{% endtabs %} + +*** + +## Next Steps + +You can use an encoder to scan a plastic key card to read its encoded parameters. The scan result includes the card's properties, such as its card number, serial number, and other useful details. For more information, see [Scanning Encoded Cards](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/scanning-encoded-cards.md). \ No newline at end of file diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/README.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/README.md deleted file mode 100644 index 95f3bda8f..000000000 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/README.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -description: Learn how to configure Visionline mobile credentials. ---- - -# Configuring Visionline Mobile Credentials - -In the ASSA ABLOY Visionline Access Management System, locks are standalone and battery-powered. All access permissions and scheduling details are contained within the key cards and mobile credentials, characterizing these systems as "data-on-card" systems. - -This guide describes how to issue guest and staff mobile credentials on the Visionline ACS. - -## Access Permission Assignment for Visionline - -Visionline is a [credential-based access control system](../../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#credential-based-access-control-systems). That is, you create ACS users and credentials. Within these credentials, you specify the set of entrances to which you want to grant access and the schedules for this access. - -
Seam resource relationships for a credential-based ACS

Seam resource relationships for a credential-based ACS

- -### Credential Types for Visionline - -When creating credentials, you can configure [guest](./#issuing-guest-mobile-credentials) mobile credentials for a Visionline ACS. Guest credentials are further subdivided into [override](./#issue-the-first-credential-for-a-reservation) and [joiner](./#issue-subsequent-credentials-for-a-reservation) credentials. An override credential serves as the first access grant for a reservation and revokes all previous guest access to the included guest room entrances. When a reservation includes multiple guests who need access, all subsequent access grants for the same reservation are joiner credentials. This type of credential provides shared access that matches the grants of existing credentials. For more details, see the following sections: - -* [Guest Mobile Credential Types](./#guest-mobile-credential-types) -* [Issue the First Credential for a Reservation](./#issue-the-first-credential-for-a-reservation) -* [Issue Subsequent Credentials for a Reservation](./#issue-subsequent-credentials-for-a-reservation) - -{% hint style="info" %} -Seam currently only supports issuing guest mobile credentials and plastic cards. -{% endhint %} - -### Access Grant Process for Visionline - -Use the following basic process to grant access in a Visionline ACS: - -1. Set up the mobile user account by creating a [user identity](../../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity). -2. Turn on the [enrollment automation](../../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md) for this user identity and credential manager. -3. Associate the user identity with an [ACS user](../../../products/access-systems/#what-is-a-user). -4. Gather the entrances to which the credential should have access. -5. Create the [guest](./#issuing-guest-mobile-credentials) mobile credential. - -*** - -## Issuing Guest Mobile Credentials - -To issue a guest mobile credential for the Visionline ACS, create a credential with `visionline_metadata.card_function_type` set to `guest`. Also, for a guest credential, you normally set `visionline_metadata.card_format` to `rfid48`, unless the guest needs a higher-capacity `TLCode` card. For more information about Visionline metadata, see [`acs_credential.visionline_metadata` Properties](../mobile-credential-related-properties.md#acs_credential.visionline_metadata-properties). - -### Guest Mobile Credential Types - -Guest mobile credentials consist of two credential types: override credentials and joiner credentials. - -When issuing the [first guest credential for a reservation](./#issue-the-first-credential-for-a-reservation), a hotel needs to guarantee that all previous access to the guest room entrance is revoked. To revoke all other access, you create an override credential that invalidates all previous access to the guest room entrance. That is, an override credential overrides any existing credentials that previously granted access to the same guest room entrance. - -Reservations may involve multiple parties. In these situations, hotels often need to provide credentials for the same guest room entrances to additional guests. To do so, [issue "joiner credentials."](./#issue-subsequent-credentials-for-a-reservation) This type of credential allows shared access with any existing credentials that already grant entry to the same guest room entrances. - -*** - -### Issue the First Credential for a Reservation - -To issue the first guest credential for a reservation, create an override credential. This credential type invalidates any existing guest access to the target entrances. When creating an override credential, set `visionline_metadata.override` to `true`. - -{% hint style="info" %} -You can also [verify whether a user identity has a phone that is set up for a credential manager](checking-if-a-user-identity-has-a-phone-that-is-set-up-for-a-credential-manager.md) and, consequently, is ready to accept an override guest credential. -{% endhint %} - -{% tabs %} -{% tab title="Python" %} -```python -# Set up the mobile user account. -user_identity = seam.user_identities.create( - user_identity_key="xxx" -) - -# Turn on the enrollment automation for this user identity -# and credential manager. -seam.enrollment_automation.launch( - credential_manager_acs_system_id=assa_credential_services.acs_system_id, - user_identity_id=guest_user_identity.user_identity_id, - create_credential_manager_user=True -) - -# Associate the user identity with the ACS user. -acs_user = seam.acs.users.get( - email="jane@example.com" -) -seam.user_identities.add_acs_user( - user_identity=user_identity.user_identity_id, - acs_user_id=acs_user.acs_user_id -) - -# Gather entrances to which the credential should have access. -room_entrance = seam.acs.entrances.get(name=f"Room {room_number}") -common_door = seam.acs.entrances.get(name=f"Main Entrance") - -# Check whether the user identity has an active endpoint on their phones. -# To learn how to verify this condition, see "Check if a user identity has -# a phone that is set up for a credential manager." -if has_active_endpoint(user_identity.user_identity_id): - # Create the override mobile credential. - cred = seam.acs.credentials.create( - acs_user_id="xxx", - credential_manager_acs_system_id="xx" - is_multi_phone_sync_credential=True, - access_method="mobile_key", - starts_at="2023-01-01 10:40:00.000", - ends_at="2023-01-04 10:40:00.000" - allowed_acs_entrance_ids=[ - room_entrance.acs_entrance_id, - common_door.acs_entrance_id - ], - visionline_metadata={ - "cardFormat": "rfid48", - "label": "%ROOMNUM% - %SITENAME%", - "override": True - } -) -``` -{% endtab %} -{% endtabs %} - -*** - -### Issue Subsequent Credentials for a Reservation - -Once you have created an override mobile credential as the first credential for a reservation, you can issue mobile credentials to additional guests on the same reservation. To do so, issue "joiner credentials." This type of credential allows shared access with any existing credentials that already grant entry to the same guest room entrances. Note that you can create joiner mobile credentials that provide access to guest room entrances, common entrances, or both. - -For example: - -* You already created an override mobile credential to grant a guest access to hotel rooms 101 and 102. Now, you create a joiner mobile credential that grants a different guest on the same reservation access to the same two hotel rooms. -* You already created an override mobile credential to grant a guest access to hotel rooms 101 and 102. Now, you create a joiner mobile credential that grants a different guest on the same reservation access to hotel room 101 only. - -To issue a joiner credential, you must specify both the entrances to which to grant access and the credentials with which to associate the new joiner credential. Use the following properties: - -* `allowed_acs_entrance_ids` -* `visionline_metadata.joiner_acs_credential_ids` - -For instructions on how to retrieve credentials that have overlapping access, see [Issuing Various Types of Guest Joiner Mobile Credentials](issuing-various-types-of-guest-joiner-mobile-credentials.md). - -{% tabs %} -{% tab title="Python" %} -```python -# Set up the mobile user account. -user_identity = seam.user_identities.create( - user_identity_key="xxx" -) - -# Turn on the enrollment automation for this user identity -# and credential manager. -seam.enrollment_automation.launch( - credential_manager_acs_system_id=assa_credential_services.acs_system_id, - user_identity_id=guest_user_identity.user_identity_id, - create_credential_manager_user: true -) - -# Associate the user identity with the ACS user. -acs_user = seam.acs.users.get( - email="jane@example.com" -) -seam.user_identities.add_acs_user( - user_identity=user_identity.user_identity_id, - acs_user_id=acs_user.acs_user_id -) - -# Gather entrances to which the credential should have access. -room_entrance = seam.acs.entrances.get(name=f"Room {room_number}") -common_door = seam.acs.entrances.get(name=f"Main Entrance") - -# Retrieve existing valid credentials for guest doors to add as joiners. -# Be sure to check that these credentials correspond with the correct -# reservation. -joiner1 = seam.acs.credentials.get(id="xxx") -joiner2 = seam.acs.credentials.get(id="yyy") -joiners = [joiner1, joiner2] - -# Create the mobile credential. -cred = seam.acs.credentials.create({ - acs_user_id: "xxx", - credential_manager_acs_system_id="xxs" - is_multi_phone_sync_credential: True, - access_method = "mobile_key", - starts_at: "2023-01-01 10:40:00.000", - ends_at: "2023-01-04 10:40:00.000", - allowed_acs_entrance_ids: [ - common_door.acs_entrance_id, - room_entrance.acs_entrance_id - ], - visionline_metadata: { - "cardFormat": "rfid48", - "label": "%ROOMNUM% - %SITENAME%", - "joiner_acs_credential_ids": [ - joiner['acs_credential_id'] for joiner in joiners - ] - } -}) -``` -{% endtab %} -{% endtabs %} - -{% tabs %} -{% tab title="Python" %} -```python -all_entrances = seam.acs.entrances.list( - acs_system_id=acs_system.acs_system_id -) - -# Filter for entrances with the common entrance category types. -common_entrance_category_types = ["common", "common (PMS)"] - -def filter_entrances_by_profile_type(entrance_list, category_types): - common_entrances = [] - for entrance in entrance_list: - if entrance["visionline_metadata"]["door_category"] in category_types: - common_entrances.append(entrance) - return common_entrances - -common_entrances = filter_entrances_by_profile_type( - all_entrances, - common_entrance_category_types -) -``` -{% endtab %} -{% endtabs %} - -
In the Seam Console, we disable the Override option when a user identity has not set up their phone to receive Visionline credentials.

In the Seam Console, we disable the Override option when a user identity has not set up their phone to receive Visionline credentials.

diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/checking-if-a-user-identity-has-a-phone-that-is-set-up-for-a-credential-manager.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/checking-if-a-user-identity-has-a-phone-that-is-set-up-for-a-credential-manager.md deleted file mode 100644 index 33169c15f..000000000 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/checking-if-a-user-identity-has-a-phone-that-is-set-up-for-a-credential-manager.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -description: >- - Learn how to determine when your app should disable the override credential - option for guest credentials. ---- - -# Checking if a User Identity Has a Phone That Is Set up for a Credential Manager - -To issue an [override guest credential](./#issue-the-first-credential-for-a-reservation) to an app user, the app user must first set up their phone. If you want to disable the "override" option where it's not available, you can use the following check before allowing a user to configure an override credential: - -{% tabs %} -{% tab title="Python" %} -``` -def has_active_endpoint(user_identity_id): - phones = seam.phones.list({ - owner_user_identity_id=user_identity_id - }) - for phone in phones: - metadata = phone.get('assa_abloy_credential_service_metadata', {}) - if metadata.get('has_active_endpoint'): - return True - return False - -# Check if any phone has an active endpoint. -user_identity = seam.user_identities.get(phone_number="1234567890") -active_endpoint_exists = has_active_endpoint(user_identity.user_identity_id) -``` -{% endtab %} -{% endtabs %} - -## Example of Disabling the Override Option When It's Not Available - -
In the Seam Console, we disable the Override option when a user identity has not set up their phone to receive Visionline credentials.

In the Seam Console, we disable the Override option when a user identity has not set up their phone to receive Visionline credentials.

diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/issuing-various-types-of-guest-joiner-mobile-credentials.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/issuing-various-types-of-guest-joiner-mobile-credentials.md deleted file mode 100644 index a2e47bd49..000000000 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/issuing-various-types-of-guest-joiner-mobile-credentials.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -description: Learn how to issue guest joiner credentials of various types. ---- - -# Issuing Various Types of Guest Joiner Mobile Credentials - -In addition to understanding the [basic process for issuing guest joiner credentials](./#issue-subsequent-credentials-for-a-reservation), it is useful to know how to issue various specific types of guest joiner credentials. - -## Before You Begin - -To issue a [joiner credential](./#issue-subsequent-credentials-for-a-reservation), you must specify the guest door credentials with which to associate the new joiner credential. To identify and retrieve these existing valid credentials, use the following process: - -1. Identify the guest entrances to which you want to issue the joiner credential. -2. Retrieve the existing guest credentials that have been issued for these guest entrances. -3. Issue the joiner credential and include these guest credentials as joiners. - -{% tabs %} -{% tab title="Python" %} -```python -# Define the list of guest entrances to check. -guest_entrance_ids = [ - room_101.acs_entrance_id, - room_102.acs_entrance_id, -] - -# Initialize a list to hold credentials for each entrance. -all_credentials = [] - -# Retrieve all valid credentials for each entrance individually. -for entrance_id in guest_entrance_ids: - credentials = seam.acs.entrances.list_credentials_with_access( - acs_entrance_id=entrance_id, - include_if=["visionline_metadata.is_valid"] - ) - all_credentials.append({ - "entrance_id": entrance_id, - "credentials": credentials - }) -``` -{% endtab %} -{% endtabs %} - -*** - -## Join to a Seam Mobile Credential - -You can select either the multi-phone sync credential or the child credentials. Make sure to get the `acs_credential_id` to include in the `joiner_acs_credential_ids` list. - -```python -joiners = [joiner_mobile_parent_sync_credential, joiner_mobile_child_credential] - -# Create the mobile credential. -cred = seam.acs.credentials.create({ - acs_user_id: "xxx", - credential_manager_acs_system_id="xxs" - is_multi_phone_sync_credential: True, - access_method = "mobile_key", - allowed_acs_entrance_ids=[ - "xxxx" - ], - starts_at: "2023-01-01 10:40:00.000", - ends_at: "2023-01-04 10:40:00.000", - visionline_metadata: { - "cardFormat": "rfid48", - "label": "%ROOMNUM% - %SITENAME%", - "joiner_acs_credential_ids": [ - joiner.acs_credential_id for joiner in joiners - ] - } -}) -``` - -*** - -## Join to a Plastic Card - -You can join to a plastic card. - -```python -joiners = [joiner_plastic_card_credential] - -# Create the mobile credential. -cred = seam.acs.credentials.create({ - acs_user_id: "xxx", - credential_manager_acs_system_id="xxs" - is_multi_phone_sync_credential: True, - access_method = "mobile_key", - allowed_acs_entrance_ids=[ - "xxxx" - ] - starts_at: "2023-01-01 10:40:00.000", - ends_at: "2023-01-04 10:40:00.000", - visionline_metadata: { - "cardFormat": "rfid48", - "label": "%ROOMNUM% - %SITENAME%", - "joiner_acs_credential_ids": [ - joiner.acs_credential_id for joiner in joiners - ] - } -}) -``` diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/issuing-various-types-of-guest-mobile-credentials.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/issuing-various-types-of-guest-mobile-credentials.md deleted file mode 100644 index 30c32639f..000000000 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/issuing-various-types-of-guest-mobile-credentials.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -description: Learn how to issue guest mobile credentials of various types. ---- - -# Issuing Various Types of Guest Mobile Credentials - -In addition to understanding the [basic process for issuing guest mobile credentials](./#issuing-guest-mobile-credentials), it is useful to know how to issue guest mobile credentials of various types. - -## Single Guest in a Single Room - -To issue a credential for a single guest in a single room, create an [override guest credential](./#issue-the-first-credential-for-a-reservation). - -```python -acs_user = seam.acs.user.get(acs_user_id="xxx") - -guest_room = seam.acs.entrances.list( - acs_system_id=hotel_acs_system_id -)[0] - -seam.acs.credentials.create( - acs_user_id=acs_user.acs_user_id - credential_manager_acs_system_id="xxx" - is_multi_phone_sync_credential=True, - access_method="mobile_key", - starts_at="2023-01-01 10:40:00.000", - ends_at="2023-01-04 10:40:00.000", - allowed_acs_entrance_ids=[ - guest_room.acs_entrance_id, - main_entrance.acs_entrance_id - ], - visionline_metadata={ - "cardFormat": "rfid48", - "cardType": "guest", - "label": "%ROOMNUM% - %SITENAME%", - "override": True - } -) -``` - -*** - -## Returning Guest to a Single Room - -A new mobile key automatically overrides a previously-issued mobile credential. - -```python -acs_user = seam.acs.user.get(acs_user_id="xxx") - -new_guest_room = seam.acs.entrances.list( - acs_system_id=hotel_acs_system_id -)[0] - -seam.acs.credentials.create( - acs_user_id=acs_user.acs_user_id - credential_manager_acs_system_id="xxx" - is_multi_phone_sync_credential=True, - access_method="mobile_key", - starts_at="2023-01-01 10:40:00.000", - ends_at="2023-01-04 10:40:00.000", - allowed_acs_entrance_ids=[ - new_guest_room.acs_entrance_id, - main_entrance.acs_entrance_id - ], - visionline_metadata={ - "cardFormat": "rfid48", - "cardType": "guest", - "label": "%ROOMNUM% - %SITENAME%", - "override": True - } -) -``` - -*** - -## Multiple Guests in Multiple Rooms - -To issue credentials for multiple guests in multiple rooms, first create an [override guest credential](./#issue-the-first-credential-for-a-reservation). Then, create all subsequent guest credentials as [joiners](./#issue-subsequent-credentials-for-a-reservation). - -```python -guest_room_1 = seam.acs.entrances.list( - acs_system_id=hotel_acs_system_id -)[0] - -guest_room_2 = seam.acs.entrances.list( - acs_system_id=hotel_acs_system_id -)[0] - -first_acs_user = seam.acs.user.get(acs_user_id="xxx") - -# First credential should be an override credential. -first_credential = seam.acs.credentials.create( - acs_user_id=first_acs_user.acs_user_id - credential_manager_acs_system_id="xxx" - is_multi_phone_sync_credential=True, - access_method="mobile_key", - starts_at="2023-01-01 10:40:00.000", - ends_at="2023-01-04 10:40:00.000", - allowed_acs_entrance_ids=[ - guest_room_1.acs_entrance_id, - guest_room_2.acs_entrance_id, - main_entrance.acs_entrance_id - ], - visionline_metadata={ - "cardFormat": "rfid48", - "cardType": "guest", - "label": "%ROOMNUM% - %SITENAME%", - "override": True - } -) - -second_acs_user = seam.acs.user.get(acs_user_id="yyy") - -# Subsequent credentials should be joiners to the first credential. -seam.acs.credentials.create( - acs_user_id=second_acs_user.acs_user_id - credential_manager_acs_system_id="xxx" - is_multi_phone_sync_credential=True, - access_method="mobile_key", - starts_at="2023-01-01 10:40:00.000", - ends_at="2023-01-04 10:40:00.000", - allowed_acs_entrance_ids=[ - guest_room_1.acs_entrance_id, - guest_room_2.acs_entrance_id, - main_entrance.acs_entrance_id - ], - visionline_metadata={ - "cardFormat": "rfid48", - "cardType": "guest", - "label": "%ROOMNUM% - %SITENAME%", - "joiner_acs_credential_ids": [first_credential.acs_credential_id] - } -) -``` diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/retrieving-guest-and-common-entrances.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/retrieving-guest-and-common-entrances.md deleted file mode 100644 index 3f6e5af9a..000000000 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/retrieving-guest-and-common-entrances.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -description: >- - Learn how to fetch various types of entrances to help provide more context for - your app users. ---- - -# Retrieving Guest and Common Entrances - -You can retrieve lists of entrances. You may want to display entrances categorized by type to provide more context to your app users. To fetch only guest or common entrances, filter using the `visionline_metadata.door_category` property for entrances. The value for this property is set within the Visionline ACS. - -
You can provide context to your app users by displaying entrances categorized by type.

You can provide context to your app users by displaying entrances categorized by type.

- -## Fetch Guest Entrances - -To fetch only guest entrances, filter entrances to include only those with a `visionline_metadata.properties.door_category` of `guest`. - -{% tabs %} -{% tab title="Python" %} -```python -all_entrances = seam.acs.entrances.list( - acs_system_id=acs_system.acs_system_id -) - -# Filter for entrances with the guest entrance category type. -guest_entrance_category_types = ["guest"] - -def filter_entrances_by_profile_type(entrance_list, category_types): - guest_entrances = [] - for entrance in entrance_list: - if entrance["visionline_metadata"]["door_category"] in category_types: - guest_entrances.append(entrance) - return guest_entrances - -guest_entrances = filter_entrances_by_profile_type( - all_entrances, - guest_entrance_category_types -) -``` -{% endtab %} -{% endtabs %} - -*** - -## Fetch Common Entrances - -To fetch only common entrances, filter entrances to include only those with a `visionline_metadata.properties.door_category` of `common` or `common (PMS)`. - -{% tabs %} -{% tab title="Python" %} -```python -all_entrances = seam.acs.entrances.list( - acs_system_id=acs_system.acs_system_id -) - -# Filter for entrances with the common entrance category types. -common_entrance_category_types = ["common", "common (PMS)"] - -def filter_entrances_by_profile_type(entrance_list, category_types): - common_entrances = [] - for entrance in entrance_list: - if entrance["visionline_metadata"]["door_category"] in category_types: - common_entrances.append(entrance) - return common_entrances - -common_entrances = filter_entrances_by_profile_type( - all_entrances, - common_entrance_category_types -) -``` -{% endtab %} -{% endtabs %} diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/revoking-mobile-credentials.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/revoking-mobile-credentials.md deleted file mode 100644 index 5a6b241b2..000000000 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/revoking-mobile-credentials.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -description: Learn how to delete mobile credentials. ---- - -# Revoking Mobile Credentials - -To revoke a mobile credential, [delete the credential](../../../capability-guides/access-systems/managing-credentials.md#delete-a-credential). Seam issues a discard command for the Visionline card. If you are deleting a [multi-phone sync credential](../../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#what-are-multi-phone-sync-credentials), Seam discards all of the credentials that were created underneath it. - -{% tabs %} -{% tab title="Python" %} -**Request:** - -```python -seam.acs.credentials.delete( - acs_credential_id="66666666-6666-6666-6666-666666666666" -) -``` - -**Response:** - -``` -None -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -**Request:** - -```bash -curl -X 'POST' \ - 'https://connect.getseam.com/acs/credentials/delete' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "acs_credential_id": "66666666-6666-6666-6666-666666666666" -}' -``` - -**Response:** - -```json -{ - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -**Request:** - -```javascript -await seam.acs.credentials.delete({ - acs_credential_id: "66666666-6666-6666-6666-666666666666" -}); -``` - -**Response:** - -```json -void -``` -{% endtab %} - -{% tab title="Ruby" %} -**Request:** - -```ruby -# Coming soon! -``` - -**Response:** - -``` -# Coming soon! -``` -{% endtab %} - -{% tab title="PHP" %} -**Request:** - -```php -$seam->acs->credentials->delete( - acs_credential_id: "66666666-6666-6666-6666-666666666666" -); -``` - -**Response:** - -``` -void -``` -{% endtab %} - -{% tab title="C#" %} -**Request:** - -```csharp -seam.CredentialsAcs.Delete( - acsCredentialId: "66666666-6666-6666-6666-666666666666" -); -``` - -**Response:** - -``` -void -``` -{% endtab %} - -{% tab title="Java" %} -**Request:** - -```java -// Coming soon! -``` - -**Response:** - -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -**Request:** - -```go -_, uErr := client.Acs.Credentials.Delete( - context.Background(), &acs.CredentialsDeleteRequest{ - acsCredentialId: "66666666-6666-6666-6666-666666666666", - }, -); -``` - -**Response:** - -```json -void -``` -{% endtab %} -{% endtabs %} diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/updating-guest-mobile-credentials.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/updating-guest-mobile-credentials.md deleted file mode 100644 index bf70b7ab4..000000000 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/credential-types/updating-guest-mobile-credentials.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -description: Learn how to update guest credentials. ---- - -# Updating Guest Mobile Credentials - -Instead of updating a guest credential, you can issue a new [joiner credential](./#issue-subsequent-credentials-for-a-reservation) with the updated parameters. Seam automatically replaces the old credential with the new one. - -```python -# Creating a new mobile credential automatically revokes -# the previous one. -seam.acs.credentials.create({ - acs_user_id: "xxx", - credential_manager_acs_system_id="xxx" - is_multi_phone_sync_credential: True, - access_method = "mobile_key", - starts_at: "2023-01-01 10:40:00.000", - ends_at: "2023-01-04 10:40:00.000", - visionline_metadata: { - "cardFormat": "rfid48", - "label": "%ROOMNUM% - %SITENAME%", - "joiners": [ - "xxx", "yyy" - ] - } -}) -``` diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/mobile-credential-related-properties.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/mobile-credential-related-properties.md index 490b5162a..a0833189b 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/mobile-credential-related-properties.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/mobile-credential-related-properties.md @@ -6,3 +6,32 @@ description: >- # Mobile Credential-Related Properties +When issuing a guest mobile credential, you can use the following relevant properties: + +## `acs_credential` Properties + +These properties are applicable to [guest](credential-types/#issuing-guest-mobile-credentials) credentials for the Visionline ACS. + +
PropertyTypeDescription
is_multi_phone_sync_credentialBoolean
Optional		Indicates whether the credential is a multi-phone sync credential.
When creating a Seam mobile key for a Visionline ACS, you must set this property to true.
allowed_acs_entrance_idsArray of strings OptionalList of ACS entrance IDs to which you want to grant the specified ACS user access.
starts_atISO 8601 format
Optional		Starting timestamp for credential activation.
ends_atISO 8601 format
Optional		Ending timestamp for credential expiration.
+ +*** + +## `acs_credential.visionline_metadata` Properties + +Use the `credential.visionline_metadata` object to include brand-specific data for your Visionline credentials. + +
PropertyTypeDescription
card_function_typeEnum
Optional		guest
cardFormatEnum
Required

rfid48 | TLCode

  • rfid48: A low-capacity card. It can store up to 33 consecutive guest rooms, 28 common rooms, and 7 additional rooms.
  • TLCode: A high capacity RFID card (for card types needing more than 48 bytes).

For guest cards, generally use rfid48.

For guest advanced cards, which need a higher capacity format, use TLCode.

labelString
Optional		"Label" field data for mobile credentials. This field may contain plain text, as well as predefined placeholders. The placeholders are surrounded by percent signs (%).
See Label Placeholders.
overrideBoolean
Optional		Indicates whether this guest credential invalidates any previously-issued credentials for overlapping entrances.
Applicable only to guest credentials.
joiner_acs_credential_idsArray of strings OptionalList of credential IDs with which the current guest credential shares entrance access. When override_previous_credentials is false, joiner_acs_credential_ids becomes a mandatory field.
Applicable only to guest credentials.
assa_abloy_credential_service_mobile_endpoint_idString
Optional		ID of the ASSA ABLOY Credential Service mobile endpoint associated with the credential.
is_validBoolean
Optional		Indicates whether the credential is currently valid.
+ +*** + +## Label Placeholders + +The `label` field provides "label" field data for mobile credentials. This field may contain plain text, as well as predefined placeholders. The placeholders are surrounded by percent signs (`%`). Visionline replaces these placeholders with the actual values before issuing mobile keys. The final text is truncated to 32 characters. The valid placeholders are as follows: + +* `%ROOMNUM%`: Replaced with main guest room number or name. +* `%ROOMLIST%`: Replaced with comma-separated list of guest rooms. +* `%ROOMRANGE%`: Replaced with hyphen-separated room range. Alternately, if some rooms do not fit into any range, then they are added as a comma-separated list. +* `%SITENAME%`: Name of the property. +* `%CARDNUM%`: Credential ID. +* `%UUID%`: BLE UUID. +* `%USERID%`: Value passed in the UI field. \ No newline at end of file diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/README.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/README.md index f9bfa8e42..65bb7c888 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/README.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/README.md @@ -1,132 +1,17 @@ --- -description: Learn how to configure your Visionline ACS for integration with Seam. +description: Learn how to develop and then launch your Visionline mobile key integration. --- -# Visionline ACS Setup Instructions +# Developing and Launching Your Visionline Mobile Key App -Seam's Visionline ACS integration enables you to create the following two types of applications: +You can use your own Visionline development account to develop your Visionline mobile key app. Then, launch your app into production. -* Apps that issue and encode Visionline plastic cards -* Mobile apps that issue Visionline mobile keys +See the following instructions: -{% hint style="info" %} -For information about Seam mobile keys, see [Mobile Access](../../../capability-guides/mobile-access/). -{% endhint %} +## Step 1: Development Phase -Integrating Visionline with Seam consists of a development phase and a production phase. The setup processes and requirements differ between these two phases. +* [Developing Your Visionline Mobile Key App](developing-your-visionline-mobile-key-app/) -This topic provides the following process overviews with links to complete instructions: +## Step 2: Launch Phase -* [Developing and Launching a Plastic Card Encoding Solution](./#developing-and-launching-a-plastic-card-encoding-solution) - * [Develop a Plastic Card Encoding App Using a Real Visionline Server](./#develop-a-plastic-card-encoding-app-using-a-real-visionline-server) - * [Develop a Plastic Card Encoding App Using a Sandbox Workspace](./#develop-a-plastic-card-encoding-app-using-a-sandbox-workspace) - * [Launch Your Visionline Plastic Card Encoding App](./#launch-your-visionline-plastic-card-encoding-app-to-a-live-visionline-system) -* [Developing and Launching a Mobile Key Solution](./#developing-and-launching-a-mobile-key-solution) - * [Develop Your Visionline Mobile Key App](./#develop-your-visionline-mobile-key-app) - * [Launch Your Visionline Mobile Key App](./#launch-your-visionline-mobile-key-app) - -*** - -## Developing and Launching a Plastic Card Encoding Solution - -The following sections describe the major steps of the setup process for developing and launching a plastic card encoding solution: - -### Develop a Plastic Card Encoding App Using a Real Visionline Server - -1. Install your Visionline application using your development account. - - Contact Seam at [support@seam.co](mailto:support@seam.co) to obtain access. -2. Configure Visionline and set it up to work with plastic cards. - 1. Unblock the required ports. - 2. Make sure that Visionline is configured with an appropriate user account. - 3. Buy and install a [Visionline card encoder](https://estore.assaabloyglobalsolutions.com/no/marine/rfid-encoder-updater-complete.html) and then connect it to your Visionline server. - 4. Set up all door locks. - 5. Use Lock Service 3G to program the door locks. -3. Create a Seam production workspace. - - You can continue to use this workspace in your production phase as well. -4. Connect your Visionline development account to Seam. - - This step includes installing and running Seam Bridge to connect your on-premises Visionline application to Seam. - -For detailed instructions, see [Developing Your Visionline Plastic Card Encoding App Using a Real Visionline Server](developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/). - -*** - -### Develop a Plastic Card Encoding App Using a Sandbox Workspace - -1. Create a sandbox workspace.\ - A sandbox workspace enables you to develop and test your app using Seam-provided virtual systems and devices. -2. Connect the virtual Visionline ACS to Seam. - -For detailed instructions, see [Developing Your Visionline Plastic Card Encoding App Using a Sandbox Workspace](developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/). - -*** - -### Launch Your Visionline Plastic Card Encoding App to a Live Visionline System - -1. Confirm that your production Visionline site meets the system requirements. -2. Make sure that Visionline is configured with an appropriate user account. -3. Purchase the required Callback option from ASSA ABLOY and import it into Visionline. -4. Connect your Visionline production account to Seam. - - Either create a new production workspace or use your existing production workspace.\ - This step also includes installing Seam Bridge. - -For detailed instructions, see [Launching Your Visionline Plastic Card Encoding App](developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/). - -*** - -## Developing and Launching a Mobile Key Solution - -The following sections describe the major steps of the setup process for developing and launching a mobile key solution: - -### Develop Your Visionline Mobile Key App - -1. Sign up for and complete the ASSA ABLOY mobile development course. -2. Install your Visionline app. -3. Configure Visionline using your development account. - 1. Unblock the required ports. - 2. Make sure that Visionline is configured with an appropriate user account. - 3. Set up your Credential Services account in the Visionline application. - 4. Configure the mobile access UUID in the Visionline application. - 5. Set up all door locks with Bluetooth low energy (BLE) profiles. - 6. Use Lock Service 3G to program the door locks. -4. Create a Seam production workspace. - - You can continue to use this workspace in your production phase as well. -5. Connect your Visionline site to Seam using your Visionline development account. - - This step includes installing and running Seam Bridge to connect your on-premises Visionline application to Seam. - - 1. Also, add your Visionline development application ID in Seam Console. - -For detailed instructions, see [Developing Your Visionline Mobile Key App](developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/). - -*** - -### Launch Your Visionline Mobile Key App - -1. Pass the ASSA ABLOY certification process. -2. Confirm that your production Visionline site meets the system requirements. -3. Configure all door locks for use with mobile keys. - - {% hint style="info" %} - This process can be quite time-consuming because it requires interaction with all locks. - {% endhint %} - - 1. Make sure that the BLE module is installed on all locks. - 2. Set up all door locks with BLE profiles. - 3. Use Lock Service 3G to program all locks. -4. Configure Visionline using your production account. - 1. Make sure that Visionline is configured with an appropriate user account. - 2. Purchase the following required options from ASSA ABLOY and import them into Visionline: - * Callback options - * Mobile Service option with your tenant account -5. Connect your Visionline production instance to Seam. - - Either create a new production workspace or use your existing production workspace. - - This step also includes installing Seam Bridge and adding your Visionline application ID in your workspace. - -For detailed instructions, see [Launching Your Visionline Mobile Key App](developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/). +* [Launching Your Visionline Mobile Key App](launching-your-visionline-mobile-key-app/) diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/README.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/README.md index 077b73d6e..9b3860f79 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/README.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/README.md @@ -4,3 +4,28 @@ description: Learn how to develop your Visionline mobile key integration. # Developing Your Visionline Mobile Key App +You can use Visionline with your development account to develop and test your Visionline mobile key app. + +For detailed instructions, see the following topics: + +[Step 1: Complete the ASSA ABLOY Mobile Development Course](step-1-complete-the-assa-abloy-mobile-development-course.md) + +[Step 2: Install Your Visionline Application](step-2-install-your-visionline-application.md) + +[Step 3: Unblock Required Ports](step-3-unblock-required-ports.md) + +[Step 4: Configure a Visionline User Account](step-4-configure-a-visionline-user-account.md) + +[Step 5: Set up Your Credential Services Account in Visionline](step-5-set-up-your-credential-services-account-in-visionline.md) + +[Step 6: Configure the Mobile Access UUID in Visionline](step-6-configure-the-mobile-access-uuid-in-visionline.md) + +[Step 7: Set up Door Locks with BLE Profiles](step-7-set-up-door-locks-with-ble-profiles.md) + +[Step 8: Program Door Locks](step-8-program-door-locks.md) + +[Step 9: Create a Production Workspace](step-9-create-a-production-workspace.md) + +[Step 10: Connect Your Visionline Development Account to Seam](../../../../assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md) + +[Next Steps](next-steps.md) diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/next-steps.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/next-steps.md index e824cbe00..c6bded3a7 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/next-steps.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/next-steps.md @@ -6,3 +6,11 @@ description: >- # Next Steps +Once you've set up your Visionline ACS using your Visionline development account, proceed to the following steps: + +1. Develop your Visionline mobile key app. +2. Test your app. +3. Obtain ASSA ABLOY certification for your Visionline mobile key app +4. Launch your app into production. + +For details about obtaining certification and launching your app, see [Launching Your Visionline Mobile Key App](../launching-your-visionline-mobile-key-app/). diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-1-complete-the-assa-abloy-mobile-development-course.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-1-complete-the-assa-abloy-mobile-development-course.md index 5e90b78df..a8e44b963 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-1-complete-the-assa-abloy-mobile-development-course.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-1-complete-the-assa-abloy-mobile-development-course.md @@ -4,3 +4,15 @@ description: Learn how to sign up for the mandatory ASSA ABLOY mobile developmen # Step 1: Complete the ASSA ABLOY Mobile Development Course +Sign up for and complete the mandatory ASSA ABLOY mobile development course. For details, send an email to either of the following addresses: + +* [mobile.access.globalsolutions@assaabloy.com](mailto:mobile.access.globalsolutions@assaabloy.com) +* [onboardingprogram@assaabloy.com](mailto:onboardingprogram@assaabloy.com) + +As part of this course, ASSA ABLOY provides you with the following items: + +* Demo lock that includes the required BLE module +* Development Visionline account +* Development ASSA ABLOY Credential Services account + +Note that the course shows you how to install and set up Visionline using your development account. You must use this development account to develop your app. diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md similarity index 98% rename from docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md rename to docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md index 4d2fc6131..66262f743 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md @@ -17,7 +17,7 @@ To develop your mobile key app, perform the following procedures to connect your ## Connect Credential Services to Seam -ASSA ABLOY Credential Services stores all the mobile credentials that your application issues. For more information about ASSA ABLOY Credential Services, see the [ASSA ABLOY Credential Services integration guide](../../../../assa-abloy-credential-services.md). +ASSA ABLOY Credential Services stores all the mobile credentials that your application issues. For more information about ASSA ABLOY Credential Services, see the [ASSA ABLOY Credential Services integration guide](../../../../assa-abloy-credential-services-credential-manager.md). You received a Credential Services development "tenant" account during the [mandatory ASSA ABLOY mobile development course](../../../../assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-1-complete-the-assa-abloy-mobile-development-course.md). To find out the credentials and details for this account, see [Retrieve Your ASSA ABLOY Credential Services Development Account Details](step-10-connect-your-visionline-development-account-to-seam.md#retrieve-your-assa-abloy-credential-services-development-account-details). Then, [connect your development Credential Services account to Seam](step-10-connect-your-visionline-development-account-to-seam.md#connect-credential-services). diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-2-install-your-visionline-application.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-2-install-your-visionline-application.md index e92e81b9a..ec1d78250 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-2-install-your-visionline-application.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-2-install-your-visionline-application.md @@ -6,3 +6,45 @@ description: >- # Step 2: Install Your Visionline Application +You can install the Visionline application and use a development—pre-certification—Visionline account to develop and test your mobile key app. + +{% hint style="info" %} +The [mandatory ASSA ABLOY mobile development course](step-1-complete-the-assa-abloy-mobile-development-course.md) shows you how to install and set up Visionline using your development account. If you have already installed Visionline as part of the ASSA ABLOY mobile development course, skip this step. +{% endhint %} + +*** + +## System Requirements + +Make sure that your computer meets the following requirements: + +* Key server: + * Visionline V1.27 + * Windows 10 1901 (or newer) + * Hosted in a location where internet traffic is allowed +* ASSA ABLOY online locks: + * Bluetooth modules and licenses installed + +For more details, see the following ASSA ABLOY Visionline document: + +{% file src="../../../../../.gitbook/assets/VisiOnline Server Client and DCOM Port Requirements.pdf" %} + +*** + +## Install Visionline + +Install the Visionline application on a Windows computer. + +{% hint style="info" %} +When prompted for an account username and password, you must specify the username and password of the Windows account that has administrative rights to the computer on which you are installing Visionline. +{% endhint %} + +For detailed instructions, see the following ASSA ABLOY Visionline document: + +{% file src="../../../../../.gitbook/assets/66 5013 142-8 Installation instruction Visionline.pdf" %} + +*** + +## Start Visionline + +When you open the Visionline application, choose unlicensed mode. diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-3-unblock-required-ports.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-3-unblock-required-ports.md index 9ee569290..2b98176ff 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-3-unblock-required-ports.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-3-unblock-required-ports.md @@ -4,3 +4,25 @@ description: Learn which ports are required for using Visionline. # Step 3: Unblock Required Ports +Unblock the required ports on the Visionline server and client. + +1. Unblock the following ports on the server: + * All files in the Visionline `Program Files` and `ProgramData` folders\ + The default locations are `C:\Program Files\ASSA ABLOY\Visionline` and `C:\ProgramData\ASSA ABLOY\Visionline`. + * Firewall ports: + * Port 135 (TCP) + * 3001 (TCP) + * 7799, 7788 (TCP/UDP) + * Lock Service Port (27015 default) (TCP) + * PMS port (4000 default) (TCP) +2. Unblock the following ports on the client: + * All files in the Visionline `Program Files` and `ProgramData` folders\ + The default locations are `C:\Program Files\ASSA ABLOY\Visionline` and `C:\ProgramData\ASSA ABLOY\Visionline`. + * Firewall ports + * Port 135 (TCP) + * 3001 (TCP) + * DCOM ports + +For more details, see the following ASSA ABLOY Visionline document: + +{% file src="../../../../../.gitbook/assets/VisiOnline Server Client and DCOM Port Requirements.pdf" %} diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-4-configure-a-visionline-user-account.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-4-configure-a-visionline-user-account.md index 41db4e687..ac949fb6b 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-4-configure-a-visionline-user-account.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-4-configure-a-visionline-user-account.md @@ -4,3 +4,48 @@ description: Learn how to set up a Visionline user account to integrate with Sea # Step 4: Configure a Visionline User Account +Make sure that your Visionline application is configured with an appropriate user account. You use this account to connect the Visionline instance with Seam. You can use the default `sym` username and password. + +Alternately, the Visionline ACS administrator can create a Visionline user specifically for the connection with Seam. This user must be configured as an operator that uses the System Manager operator template. This user must also have a password. + +To create a new Visionline user for the Seam connection, first create a new user. Then, configure the user as an operator that uses the System Manager operator template. + +{% hint style="info" %} +These instructions use Visionline 1.27. If you are using Visionline 1.28, you may notice differences in a few field names. +{% endhint %} + +1. Log in to the Visionline application as a user with System Manager access. + + When opening Visionline during the development phase, use unlicensed mode. +2. Create a new Visionline user. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System administration** section of the left navigation pane, double-click **Users**. + 3. In the **Users** window, click **Add**. + 4. In the **User details** window, type a **User ID** for the new user, for example, `Seam Integration`. + 5. Type the **Last name** of the user, for example, `Integration`. + 6. Type the **First name** of the user, for example, `Seam`. + 7. Select the **User group** to which to assign the user. + 8. Optionally, in the **PIN** field, type a PIN for the user. + 9. If you've added a PIN, in the **Confirm PIN** field, type the same PIN for the user. + 10. Click **Save**. + 11. In the **User details** dialog, click **Close**. + 12. In the **Users** window, click **Close**. + +
Add a Visionline user for the connection with Seam.

Add a Visionline user for the connection with Seam.

+3. Configure the new user as an operator that uses the System Manager operator template. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System access** section of the left navigation pane, double-click **Operators**. + 3. In the **Operators** window, click **Add**. + 4. In the **Operator details** dialog, click **...** next to the **User name** field. + 5. In the **Users \** window, select the user that you created and then click **Select**. + 6. In the **Operator details** dialog, select **System Manager** as the **Operator template**.\ + Alternately, you can create a new operator template for the new user, but you must make sure that this operator template has access to all permissions. + 7. In the **Password** and **Confirm Password** fields, type a password for the user. + 8. Click **Save**. + 9. In the **Operator details** dialog, click **Close**. + 10. In the **Operators** window, click **Close**. + +
Configure the new user as an operator with the System Manager operator template.

Configure the new user as an operator with the System Manager operator template.

+4. Note the username and password for this Visionline user. You must use these credentials when you [connect your Visionline account to Seam](../../../../assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-10-connect-your-visionline-development-account-to-seam.md). diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-5-set-up-your-credential-services-account-in-visionline.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-5-set-up-your-credential-services-account-in-visionline.md index d4bf7570b..1e439fc49 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-5-set-up-your-credential-services-account-in-visionline.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-5-set-up-your-credential-services-account-in-visionline.md @@ -6,3 +6,37 @@ description: >- # Step 5: Set up Your Credential Services Account in Visionline +Set up your development Credential Services account in the Visionline application. + +1. At the bottom of the left navigation pane in the Visionline application, click **Lists**. +2. In the **System setup** section of the left navigation pane, double-click **Mobile Access Accounts**. +3. Click **Add**. +4. In the **Mobile Access account details** window, enter your development Credential Services account details. + + Note that you received these credentials and details during the [mandatory ASSA ABLOY mobile development course](step-1-complete-the-assa-abloy-mobile-development-course.md). Alternately, see [Retrieve Your ASSA ABLOY Credential Services Development Account Details](step-5-set-up-your-credential-services-account-in-visionline.md#retrieve-your-assa-abloy-credential-services-development-account-details). + + 1. Type a **Name** for the mobile access account. + 2. Select the **Set As Default Account** checkbox. + 3. Type the **URL** of the credential server. + 4. Type **User name** and **Password** for your development Credential Services account. + 5. Type the Credential Services **System ID**. + 6. Click **Test** to verify these credentials. + 7. Click **Save**. + + + +

In Visionline, create a mobile access account with your Credential Services account details.

+ +*** + +## Retrieve Your ASSA ABLOY Credential Services Development Account Details + +Locate your ASSA ABLOY Credential Services development tenant account details in the ASSA ABLOY Global Solutions Technology Partner Portal. + +1. In a web browser, go to the [ASSA ABLOY Global Solutions Technology Partner Portal](https://my.assaabloyglobalsolutions.com/tpp). +2. Log in to the ASSA ABLOY Global Solutions Technology Partner Portal. +3. Click **Accounts > Account List**. + +
In the ASSA ABLOY Global Solutions Technology Partner Portal, click Accounts > Account List.
+4. In the **Agreements** area, locate and open the text (`.txt`) file.\ + This text file contains your ASSA ABLOY tenant account username and password, as well as your system ID, application ID, and credential services URL. diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-6-configure-the-mobile-access-uuid-in-visionline.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-6-configure-the-mobile-access-uuid-in-visionline.md index e1f12789c..f509dbe49 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-6-configure-the-mobile-access-uuid-in-visionline.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-6-configure-the-mobile-access-uuid-in-visionline.md @@ -6,3 +6,13 @@ description: >- # Step 6: Configure the Mobile Access UUID in Visionline +Configure the mobile access UUID in the Visionline application. + +Set this property to `1` for the development phase, that is, for anytime that you're using your development Visionline account to integrate with Seam. + +1. In the top menu, click **Tools > Options**. +2. In the left navigation pane of the **Options** window, click **Mobile Access**. +3. Make sure that the **UUID** field is set to `1`. +4. If needed, click **Apply**. + +
Make sure that the mobile access UUID is set to 1 for your development Visionline account.

Make sure that the mobile access UUID is set to 1 for your development Visionline account.

diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-7-set-up-door-locks-with-ble-profiles.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-7-set-up-door-locks-with-ble-profiles.md index 9bec4ef08..44d71fad0 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-7-set-up-door-locks-with-ble-profiles.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-7-set-up-door-locks-with-ble-profiles.md @@ -6,3 +6,107 @@ description: >- # Step 7: Set up Door Locks with BLE Profiles +In the Visionline application, set up all door locks for your Visionline mobile key integration. + +Use the Visionline application to define guest room and common door locks. First, set up the desired door areas, such as `Guest Doors` and `Common Doors`. Then, define each door and assign it to the appropriate door area. When you define a door or set of doors, you also choose a door type, to determine the access behavior of the door. Visionline door types include guest, guest entrance, guest common, elevator reader, elevator reader relay, and so on. + +Note that for common doors, guest entrance doors and elevator reader relays automatically give access to guests within a specific guest door range, such as common entrances. Then, you assign elevator reader relays to the corresponding elevator reader. + +For guest common doors, you must grant guest access manually, such as for a gym door or parking entrance. + +{% hint style="info" %} +These instructions use Visionline 1.27. If you are using Visionline 1.28, you may notice differences in a few field names. +{% endhint %} + +*** + +## Set up Guest Room Locks + +When defining guest room doors, first create a door area and then create a door of the **Guest** door type. + +1. Log in to the Visionline application. +2. Set up a door area for guest rooms. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System setup** section of the left navigation pane, double-click **Door areas**. + 3. In the **Door areas** window, click **Add**. + 4. In the **Door area details** dialog, type a name and, optionally, a description for the new door area.\ + For example, you could create a door area named `Guest Doors`. + 5. Click **Save**. + 6. To add more door areas, click **New** and then repeat this process in the **Door area details** dialog. + 7. When you are done adding door areas, in the **Door area details** dialog, click **Close**. + 8. In the **Door areas** window, click **Close**. + +
Create a door area for guest room doors.

Create a door area for guest room doors.

+3. Define each set of guest room doors. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System setup** section of the left navigation pane, double-click **Doors**. + 3. In the **Doors** window, click **Add**. + 4. In the **Door details** window, select **Guest** as the door **Type**. + 5. In the **Number** field, type the door range.\ + For example: `101-109` + 6. In the **Area** field, select the guest door area that you created.\ + For example: **Guest Doors** + 7. In the left navigation pane of the **Door details** window, click **Profiles**. + 8. In the **Profiles** pane, select the desired BLE profile. + 9. Click **Save**. + 10. To add more door sets, click **New** and then repeat this process in the **Door details** window. + 11. When you are done adding door sets, in the **Door details** window, click **Close**. + 12. In the **Doors** window, click **Close**. + +
Create a set of guest room doors using the door area that you created.

Create a set of guest room doors using the door area that you created.

+ +*** + +## Set up Common Door Locks + +When defining common doors, make sure to choose the appropriate door type. Visionline door types include the following, among others: + +
Door TypeDescription
Guest entranceSpecify a set of guest doors to give automatic access to guests within this range. You can use this door type for common entrances.
Guest commonYou must grant access to doors of this type explicitly to specific guest credentials. You can use this door type for gym doors, parking entrances, and so on.
Elevator reader relayThis door type represents a floor button or relay within an elevator. Specify a set of guest doors to give automatic access to guests within this range. Assign each elevator reader relay to the corresponding "slot" in an elevator reader definition.
Elevator readerThe door type serves as an organization mechanism for sets of elevator reader relays.
+ +{% hint style="info" %} +For more information about door types, see the Visionline Help. +{% endhint %} + +To define a common door, first create a door area and then create a door of the appropriate type. + +1. Log in to the Visionline application if you are not already logged in. +2. Set up a door area for the group of common doors. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System setup** section of the left navigation pane, double-click **Door areas**. + 3. In the **Door areas** window, click **Add**. + 4. In the **Door area details** dialog, type a name and, optionally, a description for the new door area.\ + For example, you could create a door area named `Common Doors`. + 5. Click **Save**. + 6. To add more door areas, click **New** and then repeat this process in the **Door area details** dialog. + 7. When you are done adding door areas, in the **Door area details** dialog, click **Close**. + 8. In the **Door areas** window, click **Close**. + +
Create a door area for common doors.

Create a door area for common doors.

+3. Define each common door. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System setup** section of the left navigation pane, double-click **Doors**. + 3. In the **Doors** window, click **Add**. + 4. In the **Door details** window, select the appropriate door **Type**.\ + See the table at the beginning of this section for descriptions of some common door types. + 5. Type a **Name** for the door, reader, relay, or other entrance. + 6. For a guest entrance door or elevator reader relay, type the beginning and ending room numbers to define the associated **Room interval**.\ + Note that for guest common entrances, you set up access permissions explicitly when creating guest or other credentials. + 7. In the **Area** field, select the common door area that you created.\ + For example: **Common Doors** + 8. For an elevator reader, set the relay outputs to define the access permissions by floor or other output: + 1. In the **Relay outputs** table, select an output. + 2. Click **Select**. + 3. In the **Select elevator reader relay** dialog, select the corresponding elevator reader relay and then click **OK**. + 4. Repeat this process for any additional relay outputs. + 9. In the left navigation pane of the **Door details** window, click **Profiles**. + 10. In the **Profiles** pane, select the desired BLE profile. + 11. Click **Save**. + 12. To add more common doors, click **New** and then repeat this process in the **Door details** window. + 13. When you are done adding common doors, in the **Door details** window, click **Close**. + 14. In the **Doors** window, click **Close**. + +
Create one or more common doors using the door area that you created.

Create one or more common doors using the door area that you created.

diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-8-program-door-locks.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-8-program-door-locks.md index 33b534405..0183c5079 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-8-program-door-locks.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-8-program-door-locks.md @@ -4,3 +4,151 @@ description: Learn how to program door locks for your mobile key integration. # Step 8: Program Door Locks +Once you have [set up door locks](step-7-set-up-door-locks-with-ble-profiles.md) in the Visionline application, use the Lock Service 3G application to program the door locks themselves. When you program a lock, you download the identity and settings for the lock from Lock Service 3G to the lock. + +{% hint style="info" %} +As part of its [mobile development course](step-1-complete-the-assa-abloy-mobile-development-course.md), ASSA ABLOY provides a demo lock that includes the required BLE module. +{% endhint %} + +This process consists of the following basic steps: + +1. [Install Lock Service 3G on a laptop or tablet.](step-8-program-door-locks.md#install-lock-service-3g) +2. [Configure the Visionline application to download door lock data to Lock Service 3G.](step-8-program-door-locks.md#configure-visionline-for-lock-service-3g) +3. [Configure Lock Service 3G to connect to the Visionline server.](step-8-program-door-locks.md#configure-lock-service-3g-to-connect-to-the-visionline-server) +4. [Download door lock data from the Visionline server to Lock Service 3G.](step-8-program-door-locks.md#download-door-lock-data-to-lock-service-3g) +5. [Initialize each door lock to program it with the correct settings.](step-8-program-door-locks.md#initialize-door-locks) + +*** + +## Install Lock Service 3G + +Install the Lock Service 3G on a Windows laptop or tablet that you can move to each door lock. You use a USB-to-lock interface cable to connect this laptop or tablet to each door lock. + +{% hint style="info" %} +If the USB-to-lock interface cable does not work correctly, you may need to install the following driver: + +`CDM v2.12.xx WHQL Certified.exe` +{% endhint %} + +*** + +## Configure Visionline for Lock Service 3G + +1. Log in to the Visionline application if you are not already logged in. +2. Add a device. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System setup** section of the left navigation pane, double-click **Devices**. + 3. In the **Devices** window, click **Add**. + 4. In the **Device details** window, type a **Name** for the device, such as `Lock Service 3G`. + 5. Select **Service device host** as the device **Type**. + 6. Make sure that the **Port** is `27015`. + 7. Make sure that the **Location** is **Server**. + 8. Click **Save**. + 9. In the **Device details** window, click **Close**. + 10. In the **Devices** window, click **Close**. + +
Add a device in the Visionline app.

Add a device in the Visionline app.

+3. Obtain the registration code for the Lock Service 3G instance. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System setup** section of the left navigation pane, double-click **Service devices**. + 3. In the **Service devices** window, click **Add**. + 4. Note the registration code and validity period that the Visionline application displays.\ + You must enter this code in Lock Service 3G on the laptop or tablet. + 5. Click **OK**. + 6. In the **Service devices** window, click **Close**. + +
Obtain the registration code for Lock Service 3G.

Obtain the registration code for Lock Service 3G.

+ +*** + +## Configure Lock Service 3G to Connect to the Visionline Server + +1. Open the Lock Service 3G application if you have not done so already. +2. Add a server connection. + + 1. In the **Setup** section of the left navigation pane, click **Server connections**. + 2. If the **Server connections** dialog does not display automatically, click **Add**. + 3. In the **Server connections** dialog, type a **Name** for this connection to the Visionline server.\ + Note that some of the field names in this dialog are different in different versions of Lock Service 3G. + 4. In the **Address** field, type the IP address of the Visionline server. + 5. Type the **Port** number to use to connect to the Visionline server. + 6. Click **OK**. + +
Add the connection between Lock Service 3G and the Visionline server.

Add the connection between Lock Service 3G and the Visionline server.

+3. At the right of the **Lock Service 3G** window, in the lower field in the **Serial port and host** area, select the name of the Visionline server connection that you created. + +
Select the Visionline server connection.

Select the Visionline server connection.

+4. Register Lock Service 3G on the laptop or tablet. + + 1. In the **Setup** section of the left navigation pane, click **Register PC**. + 2. In the **Register PC** area, type the registration **Code** that you obtained from the Visionline application. + 3. Click **Register**. + +
Use the registration code from the Visionline application to register Lock Service 3G.

Use the registration code from the Visionline application to register Lock Service 3G.

+ + Lock Service 3G registers with the Visionline server and displays a **Registration Finished** message. +5. Click **OK**. +6. Retrieve the Visionline system ID. + + 1. In the **Setup** section of the left navigation pane, click **System ID**. + 2. In the **System ID** area, click **Get**. + +
Retrieve the Visionline system ID.

Retrieve the Visionline system ID.

+ + Lock Service 3G retrieves the Visionline system ID and then displays a **New system ID has been set** message. +7. Click **OK**. + +*** + +## Download Door Lock Data to Lock Service 3G + +1. Open the Lock Service 3G application if you have not done so already. +2. In the **Setup** section of the left navigation pane, click **Download data from server**. +3. At the right of the **Lock Service 3G** window, in the lower field in the **Serial port and host** area, select the name of the Visionline server connection. +4. In the **Download data from server** area, click **Check all**. +5. Click **Download**. + +
Download the door lock data from the Visionline server to Lock Service 3G.

Download the door lock data from the Visionline server to Lock Service 3G.

+ +Lock Service downloads the door lock data from the Visionline server and displays a message when the download is complete. + +*** + +## Initialize Door Locks + +Perform the following steps on each lock: + +1. Only if necessary, update the Lock Control Unit firmware.\ + **Test locks from ASSA ABLOY should already be preprogrammed with the correct firmware.**\ + For other locks, contact ASSA ABLOY to learn whether you need to update the Lock Control Unit firmware and, if so, to obtain the correct firmware version. + 1. Open the Lock Service 3G application if you have not done so already. + 2. In the **Initiation** section of the left navigation pane, click **Upload firmware**. + 3. At the right of the **Lock Service 3G** window, in the lower field in the **Serial port and host** area, select the name of the Visionline server connection. + 4. In the **Upload firmware** area, click **Browse**.\ + + +
Select the Lock Control Unit firmware to upload.

Select the Lock Control Unit firmware to upload.

+ 5. Select the firmware that ASSA ABLOY has sent to you and then click **Open**. + 6. In the **Available versions** table, right-click the appropriate firmware version and select **Save to database**.\ + + +
Save the firmware to the database.

Save the firmware to the database.

+ 7. In the **Available versions** table, select the appropriate firmware version. + 8. At the right of the **Lock Service 3G** window, in the upper field in the **Serial port and host** area, select the serial port that you want to use to connect to the lock. + +
Select the port.

Select the port.

+ 9. Connect the cable from the laptop or tablet running Lock Service 3G to the lock. + 10. At the bottom of the **Upload firmware** area, click **Upload**. +2. Open the Lock Service 3G application if you have not done so already. +3. Initialize the lock. + 1. In the **Initiation** section of the left navigation pane, click **Initialize lock**. + 2. At the right of the **Lock Service 3G** window, in the lower field in the **Serial port and host** area, select the name of the Visionline server connection. + 3. In the **Initialize lock** area, expand the appropriate door area and select the lock that you want to initialize. + 4. Select the **Read parameters after successful initialization** checkbox. + 5. Select the **Include BLE configuration data** checkbox. + 6. At the right of the **Lock Service 3G** window, in the upper field in the **Serial port and host** area, select the serial port that you want to use to connect to the lock. + 7. Connect the cable from the laptop or tablet running Lock Service 3G to the lock and then click **Initialize**. + +
Connect Lock Service 3G to each lock and initialize it.

Connect Lock Service 3G to each lock and initialize it.

diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-9-create-a-production-workspace.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-9-create-a-production-workspace.md index 944a08fc7..0ffa41dae 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-9-create-a-production-workspace.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/developing-your-visionline-mobile-key-app/step-9-create-a-production-workspace.md @@ -6,3 +6,15 @@ description: >- # Step 9: Create a Production Workspace +Create a Seam production workspace to connect your Visionline account to Seam. You can continue to use this workspace in your production phase as well. + +1. Log in to [Seam Console](https://console.seam.co/). +2. In the upper-left corner, click the workspace switcher. + + ![Use the Seam Console workspace switcher to switch between workspaces and create new workspaces.](../../../../../.gitbook/assets/workspace-switcher.png) +3. Click **New Workspace**. +4. In the **Add a Workspace** dialog, type a name for your new workspace and your company name. +5. Disable **Sandbox mode**. + + ![To create a production workspace, disable sandbox mode.](../../../../../.gitbook/assets/add-production-workspace.png) +6. Click **Create Workspace**. diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/README.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/README.md index 183995d9f..9f684007d 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/README.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/README.md @@ -4,3 +4,36 @@ description: Learn how to launch your Visionline mobile key app into production. # Launching Your Visionline Mobile Key App +Once you have developed and tested your Visionline mobile key app, you can launch your app into production. + +For detailed instructions, see the following topics: + +[Step 1: Obtain ASSA ABLOY Certification for Your Mobile Key App](step-1-obtain-assa-abloy-certification-for-your-mobile-key-app.md) + +[Step 2: Confirm That Your Visionline Site Meets the Requirements](step-2-confirm-that-your-visionline-site-meets-the-requirements.md) + +[Step 3: Confirm BLE Module on All Locks](step-3-confirm-ble-module-on-all-locks.md) + +{% hint style="info" %} +This process can be quite time-consuming because it requires interaction with all locks. +{% endhint %} + +[Step 4: Set up Door Locks with BLE Profiles](step-4-set-up-door-locks-with-ble-profiles.md) + +[Step 5: Program Door Locks](step-5-program-door-locks.md) + +{% hint style="info" %} +This process can be quite time-consuming because it requires interaction with all locks. +{% endhint %} + +[Step 6: Configure a Visionline User Account](step-6-configure-a-visionline-user-account.md) + +[Step 7: Purchase and Import the Callback and Mobile Service Options from ASSA ABLOY](step-7-purchase-and-import-the-callback-and-mobile-service-options-from-assa-abloy.md) + +[Step 8: Create a Production Workspace](step-8-create-a-production-workspace.md) + +{% hint style="info" %} +Skip this step if you have already created a production workspace during the development phase and want to use this workspace to launch your app. +{% endhint %} + +[Step 9: Connect Your Visionline Production Account to Seam](../../../../assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md) diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-1-obtain-assa-abloy-certification-for-your-mobile-key-app.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-1-obtain-assa-abloy-certification-for-your-mobile-key-app.md index b9dbbd121..2c14bf5be 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-1-obtain-assa-abloy-certification-for-your-mobile-key-app.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-1-obtain-assa-abloy-certification-for-your-mobile-key-app.md @@ -6,3 +6,22 @@ description: >- # Step 1: Obtain ASSA ABLOY Certification for Your Mobile Key App +To launch your mobile app for issuing Visionline mobile keys into production, you must first obtain ASSA ABLOY certification. This certification process consists of the following steps: + +* Answer a series of questions about your app. The categories of questions include app development and deployment, user authentication, credential issuance, mobile device handling, BLE reader integration, use cases, troubleshooting and support, and so on. +* Perform a set of pre-verification tests. Failing any of the pre-verification tests can result in a delay in the approval process. + +Work with the ASSA ABLOY and Seam teams to achieve certification. + +{% hint style="info" %} +Once your app is certified, ASSA ABLOY provides you with a production Credential Services tenant account and production application ID for your mobile app. ASSA ABLOY gives you the following production details: + +* Tenant account username +* Tenant account password +* Credential Services URL +* System ID +* Application ID +* Mobile access UUID + +Use this information to configure Visionline for mobile access and to connect your production Visionline account to Seam. +{% endhint %} diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-2-confirm-that-your-visionline-site-meets-the-requirements.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-2-confirm-that-your-visionline-site-meets-the-requirements.md index cd9edde49..bcd8e477e 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-2-confirm-that-your-visionline-site-meets-the-requirements.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-2-confirm-that-your-visionline-site-meets-the-requirements.md @@ -6,3 +6,26 @@ description: >- # Step 2: Confirm That Your Visionline Site Meets the Requirements +Confirm that your production Visionline site meets the following system and lock requirements: + +## System Requirements + +Make sure that your computer meets the following requirements: + +* Key server: + * Visionline V1.27 (or newer) + * Windows 10 1901 (or newer) + * Hosted in a location where internet traffic is allowed + +## Lock Requirements + +Make sure that all locks meet the following requirements: + +* ASSA ABLOY online locks: + * Bluetooth modules installed + + See [Step 3: Confirm BLE Module on All Locks](step-3-confirm-ble-module-on-all-locks.md). + +For more details, see the following ASSA ABLOY Visionline document: + +{% file src="../../../../../.gitbook/assets/VisiOnline Server Client and DCOM Port Requirements.pdf" %} diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-3-confirm-ble-module-on-all-locks.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-3-confirm-ble-module-on-all-locks.md index eca8d0020..86ae3807c 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-3-confirm-ble-module-on-all-locks.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-3-confirm-ble-module-on-all-locks.md @@ -6,3 +6,45 @@ description: >- # Step 3: Confirm BLE Module on All Locks +The Visionline integration for mobile key apps requires you to install the following BLE module on each door lock: + +[https://estore.assaabloyglobalsolutions.com/no/marine/ble-module-pcba-7001.html](https://estore.assaabloyglobalsolutions.com/no/marine/ble-module-pcba-7001.html) + +This process consists of the following basic steps: + +1. [Install Lock Service 3G on a laptop or tablet.](step-3-confirm-ble-module-on-all-locks.md#install-lock-service-3g) +2. [Confirm that all locks have the required BLE module.](step-3-confirm-ble-module-on-all-locks.md#confirm-that-all-locks-have-the-required-ble-module) + +{% hint style="info" %} +This process can be quite time-consuming because it requires interaction with all locks. +{% endhint %} + +*** + +## Install Lock Service 3G + +Install the Lock Service 3G on a Windows laptop or tablet that you can move to each door lock. You use a USB-to-lock interface cable to connect this laptop or tablet to each door lock. + +{% hint style="info" %} +If the USB-to-lock interface cable does not work correctly, you may need to install the following driver: + +`CDM v2.12.xx WHQL Certified.exe` +{% endhint %} + +*** + +## Confirm that All Locks Have the Required BLE Module + +Perform the following procedure for each lock: + +1. On the laptop or tablet, open the Lock Service 3G application. +2. Connect the cable from the laptop or tablet running Lock Service 3G to the lock. +3. At the right of the **Lock Service 3G** window, in the upper field in the **Serial port and host** area, select the serial port that you want to use to connect to the lock. + +
Select the port.

Select the port.

+4. In the **Readout** section of the left navigation pane, click **Parameters**. +5. In the **Parameters** area, click **Readout**. +6. Click the **Module** tab. +7. Confirm that the lock includes a BLE module. + +
Confirm that each lock has an installed BLE module.

Confirm that each lock has an installed BLE module.

diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-4-set-up-door-locks-with-ble-profiles.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-4-set-up-door-locks-with-ble-profiles.md index aee6e76a3..5f6de05f9 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-4-set-up-door-locks-with-ble-profiles.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-4-set-up-door-locks-with-ble-profiles.md @@ -6,3 +6,107 @@ description: >- # Step 4: Set up Door Locks with BLE Profiles +In the Visionline application, set up all door locks for your Visionline mobile key integration. + +Use the Visionline application to define guest room and common door locks. First, set up the desired door areas, such as `Guest Doors` and `Common Doors`. Then, define each door and assign it to the appropriate door area. When you define a door or set of doors, you also choose a door type, to determine the access behavior of the door. Visionline door types include guest, guest entrance, guest common, elevator reader, elevator reader relay, and so on. + +Note that for common doors, guest entrance doors and elevator reader relays automatically give access to guests within a specific guest door range, such as common entrances. Then, you assign elevator reader relays to the corresponding elevator reader. + +For guest common doors, you must grant guest access manually, such as for a gym door or parking entrance. + +{% hint style="info" %} +These instructions use Visionline 1.27. If you are using Visionline 1.28, you may notice differences in a few field names. +{% endhint %} + +*** + +## Set up Guest Room Locks + +When defining guest room doors, first create a door area and then create a door of the **Guest** door type. + +1. Log in to the Visionline application. +2. Set up a door area for guest rooms. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System setup** section of the left navigation pane, double-click **Door areas**. + 3. In the **Door areas** window, click **Add**. + 4. In the **Door area details** dialog, type a name and, optionally, a description for the new door area.\ + For example, you could create a door area named `Guest Doors`. + 5. Click **Save**. + 6. To add more door areas, click **New** and then repeat this process in the **Door area details** dialog. + 7. When you are done adding door areas, in the **Door area details** dialog, click **Close**. + 8. In the **Door areas** window, click **Close**. + +
Create a door area for guest room doors.

Create a door area for guest room doors.

+3. Define each set of guest room doors. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System setup** section of the left navigation pane, double-click **Doors**. + 3. In the **Doors** window, click **Add**. + 4. In the **Door details** window, select **Guest** as the door **Type**. + 5. In the **Number** field, type the door range.\ + For example: `101-109` + 6. In the **Area** field, select the guest door area that you created.\ + For example: **Guest Doors** + 7. In the left navigation pane of the **Door details** window, click **Profiles**. + 8. In the **Profiles** pane, select the desired BLE profile. + 9. Click **Save**. + 10. To add more door sets, click **New** and then repeat this process in the **Door details** window. + 11. When you are done adding door sets, in the **Door details** window, click **Close**. + 12. In the **Doors** window, click **Close**. + +
Create a set of guest room doors using the door area that you created.

Create a set of guest room doors using the door area that you created.

+ +*** + +## Set up Common Door Locks + +When defining common doors, make sure to choose the appropriate door type. Visionline door types include the following, among others: + +
Door TypeDescription
Guest entranceSpecify a set of guest doors to give automatic access to guests within this range. You can use this door type for common entrances.
Guest commonYou must grant access to doors of this type explicitly to specific guest credentials. You can use this door type for gym doors, parking entrances, and so on.
Elevator reader relayThis door type represents a floor button or relay within an elevator. Specify a set of guest doors to give automatic access to guests within this range. Assign each elevator reader relay to the corresponding "slot" in an elevator reader definition.
Elevator readerThe door type serves as an organization mechanism for sets of elevator reader relays.
+ +{% hint style="info" %} +For more information about door types, see the Visionline Help. +{% endhint %} + +To define a common door, first create a door area and then create a door of the appropriate type. + +1. Log in to the Visionline application if you are not already logged in. +2. Set up a door area for the group of common doors. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System setup** section of the left navigation pane, double-click **Door areas**. + 3. In the **Door areas** window, click **Add**. + 4. In the **Door area details** dialog, type a name and, optionally, a description for the new door area.\ + For example, you could create a door area named `Common Doors`. + 5. Click **Save**. + 6. To add more door areas, click **New** and then repeat this process in the **Door area details** dialog. + 7. When you are done adding door areas, in the **Door area details** dialog, click **Close**. + 8. In the **Door areas** window, click **Close**. + +
Create a door area for common doors.

Create a door area for common doors.

+3. Define each common door. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System setup** section of the left navigation pane, double-click **Doors**. + 3. In the **Doors** window, click **Add**. + 4. In the **Door details** window, select the appropriate door **Type**.\ + See the table at the beginning of this section for descriptions of some common door types. + 5. Type a **Name** for the door, reader, relay, or other entrance. + 6. For a guest entrance door or elevator reader relay, type the beginning and ending room numbers to define the associated **Room interval**.\ + Note that for guest common entrances, you set up access permissions explicitly when creating guest or other credentials. + 7. In the **Area** field, select the common door area that you created.\ + For example: **Common Doors** + 8. For an elevator reader, set the relay outputs to define the access permissions by floor or other output: + 1. In the **Relay outputs** table, select an output. + 2. Click **Select**. + 3. In the **Select elevator reader relay** dialog, select the corresponding elevator reader relay and then click **OK**. + 4. Repeat this process for any additional relay outputs. + 9. In the left navigation pane of the **Door details** window, click **Profiles**. + 10. In the **Profiles** pane, select the desired BLE profile. + 11. Click **Save**. + 12. To add more common doors, click **New** and then repeat this process in the **Door details** window. + 13. When you are done adding common doors, in the **Door details** window, click **Close**. + 14. In the **Doors** window, click **Close**. + +
Create one or more common doors using the door area that you created.

Create one or more common doors using the door area that you created.

diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-5-program-door-locks.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-5-program-door-locks.md index 099e2c22d..67fe3cb92 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-5-program-door-locks.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-5-program-door-locks.md @@ -4,3 +4,139 @@ description: Learn how to program door locks for your mobile key integration. # Step 5: Program Door Locks +Once you have [set up door locks](step-4-set-up-door-locks-with-ble-profiles.md) in the Visionline application, use the Lock Service 3G application to program the door locks themselves. When you program a lock, you download the identity and settings for the lock from Lock Service 3G to the lock. + +This process consists of the following basic steps: + +1. [Configure the Visionline application to download door lock data to Lock Service 3G.](step-5-program-door-locks.md#configure-visionline-for-lock-service-3g) +2. [Configure Lock Service 3G to connect to the Visionline server.](step-5-program-door-locks.md#configure-lock-service-3g-to-connect-to-the-visionline-server) +3. [Download door lock data from the Visionline server to Lock Service 3G.](step-5-program-door-locks.md#download-door-lock-data-to-lock-service-3g) +4. [Initialize each door lock to program it with the correct settings.](step-5-program-door-locks.md#initialize-door-locks) +5. + +*** + +## Configure Visionline for Lock Service 3G + +1. Log in to the Visionline application if you are not already logged in. +2. Add a device. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System setup** section of the left navigation pane, double-click **Devices**. + 3. In the **Devices** window, click **Add**. + 4. In the **Device details** window, type a **Name** for the device, such as `Lock Service 3G`. + 5. Select **Service device host** as the device **Type**. + 6. Make sure that the **Port** is `27015`. + 7. Make sure that the **Location** is **Server**. + 8. Click **Save**. + 9. In the **Device details** window, click **Close**. + 10. In the **Devices** window, click **Close**. + +
Add a device in the Visionline app.

Add a device in the Visionline app.

+3. Obtain the registration code for the Lock Service 3G instance. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System setup** section of the left navigation pane, double-click **Service devices**. + 3. In the **Service devices** window, click **Add**. + 4. Note the registration code and validity period that the Visionline application displays.\ + You must enter this code in Lock Service 3G on the laptop or tablet. + 5. Click **OK**. + 6. In the **Service devices** window, click **Close**. + +
Obtain the registration code for Lock Service 3G.

Obtain the registration code for Lock Service 3G.

+ +*** + +## Configure Lock Service 3G to Connect to the Visionline Server + +1. Open the Lock Service 3G application if you have not done so already. +2. Add a server connection. + + 1. In the **Setup** section of the left navigation pane, click **Server connections**. + 2. If the **Server connections** dialog does not display automatically, click **Add**. + 3. In the **Server connections** dialog, type a **Name** for this connection to the Visionline server.\ + Note that some of the field names in this dialog are different in different versions of Lock Service 3G. + 4. In the **Address** field, type the IP address of the Visionline server. + 5. Type the **Port** number to use to connect to the Visionline server. + 6. Click **OK**. + +
Add the connection between Lock Service 3G and the Visionline server.

Add the connection between Lock Service 3G and the Visionline server.

+3. At the right of the **Lock Service 3G** window, in the lower field in the **Serial port and host** area, select the name of the Visionline server connection that you created. + +
Select the Visionline server connection.

Select the Visionline server connection.

+4. Register Lock Service 3G on the laptop or tablet. + + 1. In the **Setup** section of the left navigation pane, click **Register PC**. + 2. In the **Register PC** area, type the registration **Code** that you obtained from the Visionline application. + 3. Click **Register**. + +
Use the registration code from the Visionline application to register Lock Service 3G.

Use the registration code from the Visionline application to register Lock Service 3G.

+ + Lock Service 3G registers with the Visionline server and displays a **Registration Finished** message. +5. Click **OK**. +6. Retrieve the Visionline system ID. + + 1. In the **Setup** section of the left navigation pane, click **System ID**. + 2. In the **System ID** area, click **Get**. + +
Retrieve the Visionline system ID.

Retrieve the Visionline system ID.

+ + Lock Service 3G retrieves the Visionline system ID and then displays a **New system ID has been set** message. +7. Click **OK**. + +*** + +## Download Door Lock Data to Lock Service 3G + +1. Open the Lock Service 3G application if you have not done so already. +2. In the **Setup** section of the left navigation pane, click **Download data from server**. +3. At the right of the **Lock Service 3G** window, in the lower field in the **Serial port and host** area, select the name of the Visionline server connection. +4. In the **Download data from server** area, click **Check all**. +5. Click **Download**. + +
Download the door lock data from the Visionline server to Lock Service 3G.

Download the door lock data from the Visionline server to Lock Service 3G.

+ +Lock Service downloads the door lock data from the Visionline server and displays a message when the download is complete. + +*** + +## Initialize Door Locks + +Perform the following steps on each lock: + +1. Only if necessary, update the Lock Control Unit firmware.\ + **Test locks from ASSA ABLOY should already be preprogrammed with the correct firmware.**\ + For other locks, contact ASSA ABLOY to learn whether you need to update the Lock Control Unit firmware and, if so, to obtain the correct firmware version. + 1. Open the Lock Service 3G application if you have not done so already. + 2. In the **Initiation** section of the left navigation pane, click **Upload firmware**. + 3. At the right of the **Lock Service 3G** window, in the lower field in the **Serial port and host** area, select the name of the Visionline server connection. + 4. In the **Upload firmware** area, click **Browse**.\ + + +
Select the Lock Control Unit firmware to upload.

Select the Lock Control Unit firmware to upload.

+ 5. Select the firmware that ASSA ABLOY has sent to you and then click **Open**. + 6. In the **Available versions** table, right-click the appropriate firmware version and select **Save to database**.\ + + +
Save the firmware to the database.

Save the firmware to the database.

+ 7. In the **Available versions** table, select the appropriate firmware version. + 8. At the right of the **Lock Service 3G** window, in the upper field in the **Serial port and host** area, select the serial port that you want to use to connect to the lock. + +
Select the port.

Select the port.

+ 9. Connect the cable from the laptop or tablet running Lock Service 3G to the lock. + 10. At the bottom of the **Upload firmware** area, click **Upload**. +2. Open the Lock Service 3G application if you have not done so already. +3. Initialize the lock. + 1. In the **Initiation** section of the left navigation pane, click **Initialize lock**. + 2. At the right of the **Lock Service 3G** window, in the lower field in the **Serial port and host** area, select the name of the Visionline server connection. + 3. In the **Initialize lock** area, expand the appropriate door area and select the lock that you want to initialize. + 4. Select the **Read parameters after successful initialization** checkbox. + 5. Select the **Include BLE configuration data** checkbox. + 6. At the right of the **Lock Service 3G** window, in the upper field in the **Serial port and host** area, select the serial port that you want to use to connect to the lock. + 7. Connect the cable from the laptop or tablet running Lock Service 3G to the lock and then click **Initialize**. + +
Connect Lock Service 3G to each lock and initialize it.

Connect Lock Service 3G to each lock and initialize it.

+ + {% hint style="info" %} + The lock and cable connection times out after 30 seconds. If programming the lock results in an error, try unplugging the cable from the lock and reconnecting it. Then, try initializing the lock again. + {% endhint %} diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-6-configure-a-visionline-user-account.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-6-configure-a-visionline-user-account.md index 66e8a58cb..00877ff77 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-6-configure-a-visionline-user-account.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-6-configure-a-visionline-user-account.md @@ -4,3 +4,46 @@ description: Learn how to set up a Visionline user account to integrate with Sea # Step 6: Configure a Visionline User Account +Make sure that your Visionline application is configured with an appropriate user account. You use this account to connect the Visionline instance with Seam. You can use the default `sym` username and password. + +Alternately, the Visionline ACS administrator can create a Visionline user specifically for the connection with Seam. This user must be configured as an operator that uses the System Manager operator template. This user must also have a password. + +To create a new Visionline user for the Seam connection, first create a new user. Then, configure the user as an operator that uses the System Manager operator template. + +{% hint style="info" %} +These instructions use Visionline 1.27. If you are using Visionline 1.28, you may notice differences in a few field names. +{% endhint %} + +1. Log in to the Visionline application as a user with System Manager access. +2. Create a new Visionline user. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System administration** section of the left navigation pane, double-click **Users**. + 3. In the **Users** window, click **Add**. + 4. In the **User details** window, type a **User ID** for the new user, for example, `Seam Integration`. + 5. Type the **Last name** of the user, for example, `Integration`. + 6. Type the **First name** of the user, for example, `Seam`. + 7. Select the **User group** to which to assign the user. + 8. Optionally, in the **PIN** field, type a PIN for the user. + 9. If you've added a PIN, in the **Confirm PIN** field, type the same PIN for the user. + 10. Click **Save**. + 11. In the **User details** dialog, click **Close**. + 12. In the **Users** window, click **Close**. + +
Add a Visionline user for the connection with Seam.

Add a Visionline user for the connection with Seam.

+3. Configure the new user as an operator that uses the System Manager operator template. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System access** section of the left navigation pane, double-click **Operators**. + 3. In the **Operators** window, click **Add**. + 4. In the **Operator details** dialog, click **...** next to the **User name** field. + 5. In the **Users \** window, select the user that you created and then click **Select**. + 6. In the **Operator details** dialog, select **System Manager** as the **Operator template**.\ + Alternately, you can create a new operator template for the new user, but you must make sure that this operator template has access to all permissions. + 7. In the **Password** and **Confirm Password** fields, type a password for the user. + 8. Click **Save**. + 9. In the **Operator details** dialog, click **Close**. + 10. In the **Operators** window, click **Close**. + +
Configure the new user as an operator with the System Manager operator template.

Configure the new user as an operator with the System Manager operator template.

+4. Note the username and password for this Visionline user. You must use these credentials when you [connect your Visionline account to Seam](../../../../assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md). diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-7-purchase-and-import-the-callback-and-mobile-service-options-from-assa-abloy.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-7-purchase-and-import-the-callback-and-mobile-service-options-from-assa-abloy.md index d5469885e..9deb1ef61 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-7-purchase-and-import-the-callback-and-mobile-service-options-from-assa-abloy.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-7-purchase-and-import-the-callback-and-mobile-service-options-from-assa-abloy.md @@ -6,3 +6,19 @@ description: >- # Step 7: Purchase and Import the Callback and Mobile Service Options from ASSA ABLOY +To launch your Visionline mobile key app into production, you must purchase the Callback and Mobile Service options from ASSA ABLOY and then import these options into Visionline. + +1. Purchase the Callback and Mobile Service options from ASSA ABLOY. + + To purchase these options, contact ASSA ABLOY. + + Once you purchase these options, ASSA ABLOY provides you with corresponding option codes. +2. Import the corresponding option codes into Visionline. + 1. Open Visionline. + 2. In the top menu, click **Tools** > **Option code**. + 3. In the **Option code** field, type or paste the option codes that you received from Visionline and then click **Apply**. +3. Verify that the required options have been configured. + 1. At the bottom of the Visionline left navigation pane, click **Reports**. + 2. In the **Pre-defined** section of the left navigation pane, double-click **System settings**. + 3. If desired, print or export the report. + 4. In the report, find the **`[Options]`** section and verify that the purchased options are listed. diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-8-create-a-production-workspace.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-8-create-a-production-workspace.md index 541babc1b..6162cc1a0 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-8-create-a-production-workspace.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-8-create-a-production-workspace.md @@ -6,3 +6,17 @@ description: >- # Step 8: Create a Production Workspace +If you did not create a Seam production workspace during the development phase for your Visionline mobile key app, you must create a new production workspace to connect your Visionline production account to Seam. If you did create a production workspace already, you can choose to continue using this workspace or to create a new one. + +To create a production workspace. + +1. Log in to [Seam Console](https://console.seam.co/). +2. In the upper-left corner, click the workspace switcher. + + ![Use the Seam Console workspace switcher to switch between workspaces and create new workspaces.](../../../../../.gitbook/assets/workspace-switcher.png) +3. Click **New Workspace**. +4. In the **Add a Workspace** dialog, type a name for your new workspace and your company name. +5. Disable **Sandbox mode**. + + ![To create a production workspace, disable sandbox mode.](../../../../../.gitbook/assets/add-production-workspace.png) +6. Click **Create Workspace**. diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md similarity index 98% rename from docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md rename to docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md index 9e8ec7885..ddbb5f39e 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-9-connect-your-visionline-production-account-to-seam.md @@ -19,7 +19,7 @@ If you already connected your Visionline ACS to Seam during the development phas ## Connect Credential Services to Seam -ASSA ABLOY Credential Services stores all the mobile credentials that your application issues. For more information about ASSA ABLOY Credential Services, see the [ASSA ABLOY Credential Services integration guide](../../../../assa-abloy-credential-services.md). +ASSA ABLOY Credential Services stores all the mobile credentials that your application issues. For more information about ASSA ABLOY Credential Services, see the [ASSA ABLOY Credential Services integration guide](../../../../assa-abloy-credential-services-credential-manager.md). You received a Credential Services production "tenant" account from ASSA ABLOY when you [obtained ASSA ABLOY certification](../../../../assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-1-obtain-assa-abloy-certification-for-your-mobile-key-app.md) for your mobile key app. ASSA ABLOY provided you with the following production-phase information upon certification: diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/README.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/README.md index 1fce688f7..b4c5190b8 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/README.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/README.md @@ -6,3 +6,15 @@ description: >- # Developing and Launching Your Visionline Plastic Card Encoding App +You can use your own Visionline development account—that is, an unlicensed Visionline account—to develop your Visionline plastic card encoding app. If you do not have access to a Visionline development account, you can use a Seam sandbox workspace instead. Once you have developed and tested your app, launch it into production. + +See the following instructions: + +## Step 1: Development Phase + +* [Developing Your Visionline Plastic Card Encoding App Using A Real Visionline Server](developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/) +* [Developing Your Visionline Plastic Card Encoding App Using a Sandbox Workspace](developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/) + +## Step 2: Launch Phase + +* [Launching Your Visionline Plastic Card Encoding App](launching-your-visionline-plastic-card-encoding-app-to-a-live-site/) diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/README.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/README.md index 235473f85..037b369df 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/README.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/README.md @@ -6,3 +6,28 @@ description: >- # Developing Your Visionline Plastic Card Encoding App Using a Real Visionline Server +You can use an unlicensed Visionline account to develop and test your Visionline plastic card encoding integration. Then, you can launch your app into production using a real Visionline site. + +{% hint style="info" %} +There are some differences between using an unlicensed Visionline account and using a real, production Visionline site. Consequently, when you are ready to launch your app to production, make sure to follow the [instructions for launching](../launching-your-visionline-plastic-card-encoding-app-to-a-live-site/). +{% endhint %} + +For detailed instructions, see the following topics: + +[Step 1: Install Your Visionline Application](step-1-install-your-visionline-application.md) + +[Step 2: Unblock Required Ports](step-2-unblock-required-ports.md) + +[Step 3: Configure a Visionline User Account](step-3-configure-a-visionline-user-account.md) + +[Step 4: Install a Visionline Card Encoder](step-4-install-a-visionline-card-encoder.md) + +[Step 5: Set up Door Locks](step-5-set-up-door-locks.md) + +[Step 6: Program Door Locks](step-6-program-door-locks.md) + +[Step 7: Create a Production Workspace](step-7-create-a-production-workspace.md) + +[Step 8: Connect Your Visionline Development Account to Seam](../../../../assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md) + +[Next Steps](next-steps.md) diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/next-steps.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/next-steps.md index a978d8421..7559ebbe2 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/next-steps.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/next-steps.md @@ -6,3 +6,10 @@ description: >- # Next Steps +Once you've set up your Visionline ACS using your Visionline development account, proceed to the following steps: + +1. Develop your Visionline plastic card encoding app. +2. Test your app. +3. Launch your app into production. + + For details, see [Launching Your Visionline Plastic Card Encoding App to a Live Site](../launching-your-visionline-plastic-card-encoding-app-to-a-live-site/). diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-1-install-your-visionline-application.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-1-install-your-visionline-application.md index f8db3c018..b53cd101c 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-1-install-your-visionline-application.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-1-install-your-visionline-application.md @@ -6,3 +6,43 @@ description: >- # Step 1: Install Your Visionline Application +You can install the Visionline application and use a development—pre-certification—Visionline account to develop and test your plastic card encoding app. + +To obtain access, contact Seam at [support@seam.co](mailto:support@seam.co). + +*** + +## System Requirements + +Make sure that your computer meets the following requirements: + +* Key server: + * Visionline V1.27 (or newer) + * Windows 10 1901 (or newer) + * Hosted in a location where internet traffic is allowed +* ASSA ABLOY online locks: + * Bluetooth modules and licenses installed + +For more details, see the following ASSA ABLOY Visionline document: + +{% file src="../../../../../.gitbook/assets/VisiOnline Server Client and DCOM Port Requirements.pdf" %} + +*** + +## Install Visionline + +Install the Visionline application on a Windows computer. + +{% hint style="info" %} +When prompted for an account username and password, you must specify the username and password of the Windows account that has administrative rights to the computer on which you are installing Visionline. +{% endhint %} + +For detailed instructions, see the following ASSA ABLOY Visionline document: + +{% file src="../../../../../.gitbook/assets/66 5013 142-8 Installation instruction Visionline.pdf" %} + +*** + +## Start Visionline + +When you open the Visionline application, choose unlicensed mode. diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-2-unblock-required-ports.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-2-unblock-required-ports.md index 20d60d987..655773c36 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-2-unblock-required-ports.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-2-unblock-required-ports.md @@ -4,3 +4,25 @@ description: Learn which ports are required for using Visionline. # Step 2: Unblock Required Ports +Unblock the required ports on the Visionline server and client. + +1. Unblock the following ports on the server: + * All files in the Visionline `Program Files` and `ProgramData` folders\ + The default locations are `C:\Program Files\ASSA ABLOY\Visionline` and `C:\ProgramData\ASSA ABLOY\Visionline`. + * Firewall ports: + * Port 135 (TCP) + * 3001 (TCP) + * 7799, 7788 (TCP/UDP) + * Lock Service Port (27015 default) (TCP) + * PMS port (4000 default) (TCP) +2. Unblock the following ports on the client: + * All files in the Visionline `Program Files` and `ProgramData` folders\ + The default locations are `C:\Program Files\ASSA ABLOY\Visionline` and `C:\ProgramData\ASSA ABLOY\Visionline`. + * Firewall ports + * Port 135 (TCP) + * 3001 (TCP) + * DCOM ports + +For more details, see the following ASSA ABLOY Visionline document: + +{% file src="../../../../../.gitbook/assets/VisiOnline Server Client and DCOM Port Requirements.pdf" %} diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-3-configure-a-visionline-user-account.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-3-configure-a-visionline-user-account.md index dba6c6f3a..1043c7796 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-3-configure-a-visionline-user-account.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-3-configure-a-visionline-user-account.md @@ -4,3 +4,48 @@ description: Learn how to set up a Visionline user account to integrate with Sea # Step 3: Configure a Visionline User Account +Make sure that your Visionline application is configured with an appropriate user account. You use this account to connect the Visionline instance with Seam. You can use the default `sym` username and password. + +Alternately, the Visionline ACS administrator can create a Visionline user specifically for the connection with Seam. This user must be configured as an operator that uses the System Manager operator template. This user must also have a password. + +To create a new Visionline user for the Seam connection, first create a new user. Then, configure the user as an operator that uses the System Manager operator template. + +{% hint style="info" %} +These instructions use Visionline 1.27. If you are using Visionline 1.28, you may notice differences in a few field names. +{% endhint %} + +1. Log in to the Visionline application as a user with System Manager access. + + When opening Visionline during the development phase, use unlicensed mode. +2. Create a new Visionline user. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System administration** section of the left navigation pane, double-click **Users**. + 3. In the **Users** window, click **Add**. + 4. In the **User details** window, type a **User ID** for the new user, for example, `Seam Integration`. + 5. Type the **Last name** of the user, for example, `Integration`. + 6. Type the **First name** of the user, for example, `Seam`. + 7. Select the **User group** to which to assign the user. + 8. Optionally, in the **PIN** field, type a PIN for the user. + 9. If you've added a PIN, in the **Confirm PIN** field, type the same PIN for the user. + 10. Click **Save**. + 11. In the **User details** dialog, click **Close**. + 12. In the **Users** window, click **Close**. + +
Add a Visionline user for the connection with Seam.

Add a Visionline user for the connection with Seam.

+3. Configure the new user as an operator that uses the System Manager operator template. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System access** section of the left navigation pane, double-click **Operators**. + 3. In the **Operators** window, click **Add**. + 4. In the **Operator details** dialog, click **...** next to the **User name** field. + 5. In the **Users \** window, select the user that you created and then click **Select**. + 6. In the **Operator details** dialog, select **System Manager** as the **Operator template**.\ + Alternately, you can create a new operator template for the new user, but you must make sure that this operator template has access to all permissions. + 7. In the **Password** and **Confirm Password** fields, type a password for the user. + 8. Click **Save**. + 9. In the **Operator details** dialog, click **Close**. + 10. In the **Operators** window, click **Close**. + +
Configure the new user as an operator with the System Manager operator template.

Configure the new user as an operator with the System Manager operator template.

+4. Note the username and password for this Visionline user. You must use these credentials when you [connect your Visionline account to Seam](../../../../assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md). diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-4-install-a-visionline-card-encoder.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-4-install-a-visionline-card-encoder.md index 9b0ff01af..62f574a7c 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-4-install-a-visionline-card-encoder.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-4-install-a-visionline-card-encoder.md @@ -6,3 +6,50 @@ description: >- # Step 4: Install a Visionline Card Encoder +Buy and install a Visionline card encoder—specifically, the [ASSA ABLOY RFID encoder & updater](https://estore.assaabloyglobalsolutions.com/no/marine/rfid-encoder-updater-complete.html)—and then connect it to your Visionline server. + +1. Install USB drivers. + 1. Install the USBXpress Development Kit.\ + This file is available for download from the [Silabs web site](https://www.silabs.com/Support%20Documents/Software/USBXpress_Install.exe). + 2. Connect the RFID encoder & updater to the power supply. + 3. Connect the RFID encoder & updater to the computer using the USB cable. + 4. On your Windows computer, go to the **Device Manager**. + 5. Expand the **Universal Serial Bus controllers** category. + 6. Double-click **USBXpress Device** . + 7. In the **General** tab of the **USBXpress Device Properties** window, make sure that the **Device status** is `This device is working properly`. + 8. In the Visionline bundle, under **RFID Encoder/RFID Encoder Configuration Utility**, double-click **RFIDEncoderConfig.exe**. + + Note that, starting with Visionline 1.24.0, the **RFID Encoder Configuration Utility** is automatically installed in the Visionline installation folder when **Visionline.msi** is installed. + + If the RFID encoder & updater is correctly connected to the PC and correctly uses the USBXpress driver, the serial number of the RFID encoder & updater displays in the **USB** area at the upper-left of the window. +2. Connect the card encoder to the Visionline server using USB. + + {% hint style="info" %} + To connect through USB, you must use firmware version 2.6.2.4 or higher for the RFID encoder. Visionline 1.22.1 or higher is also required. + {% endhint %} +3. Register the card encoder. + 1. Log in to the Visionline application if you are not already logged in. + 2. At the bottom of the left navigation pane, click **Lists**. + 3. In the **System setup** section of the left navigation pane, double-click **Devices**. + 4. In the **Devices** window, click **Add**. + 5. In the **Device details** window, type a **Name** for the RFID encoder & updater. + 6. If desired, type a **Description**. + 7. In the **Type** field, select **Network RFID encoder (USB)**. + +
Specify the details for the new card encoder device.

Specify the details for the new card encoder device.

+ 8. Click **...** next to the **S/N** field. + + The list displays all network RFID encoder & updaters that are connected through USB. + 9. Make sure that the correct RFID encoder & updater is selected. + +
Select the correct RFID encoder & updater.

Select the correct RFID encoder & updater.

+ 10. Select the correct **Location**. + 11. If you have selected **Server** or **Computer** as the **Location**, type the **PMS address**, if applicable. + 12. Click **Save**. + 13. In the **Device details** window, click **Close**. + 14. In the **Devices** window, click **Close**. +4. Select the card encoder to which the Visionline server should send cards. + 1. Click **File** > **Select encoder**. + 2. Select the encoder that you registered in the previous section and then click **OK**. + +
Select the card encoder that you want to use.

Select the card encoder that you want to use.

diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-5-set-up-door-locks.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-5-set-up-door-locks.md index 1eb121fe7..e72ec381a 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-5-set-up-door-locks.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-5-set-up-door-locks.md @@ -6,3 +6,103 @@ description: >- # Step 5: Set up Door Locks +In the Visionline application, set up all door locks for your Visionline plastic card encoding integration. + +Use the Visionline application to define guest room and common door locks. First, set up the desired door areas, such as `Guest Doors` and `Common Doors`. Then, define each door and assign it to the appropriate door area. When you define a door or set of doors, you also choose a door type, to determine the access behavior of the door. Visionline door types include guest, guest entrance, guest common, elevator reader, elevator reader relay, and so on. + +Note that for common doors, guest entrance doors and elevator reader relays automatically give access to guests within a specific guest door range, such as common entrances. Then, you assign elevator reader relays to the corresponding elevator reader. + +For guest common doors, you must grant guest access manually, such as for a gym door or parking entrance. + +{% hint style="info" %} +These instructions use Visionline 1.27. If you are using Visionline 1.28, you may notice differences in a few field names. +{% endhint %} + +*** + +## Set up Guest Room Locks + +When defining guest room doors, first create a door area and then create a door of the **Guest** door type. + +1. Log in to the Visionline application. +2. Set up a door area for guest rooms. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System setup** section of the left navigation pane, double-click **Door areas**. + 3. In the **Door areas** window, click **Add**. + 4. In the **Door area details** dialog, type a name and, optionally, a description for the new door area.\ + For example, you could create a door area named `Guest Doors`. + 5. Click **Save**. + 6. To add more door areas, click **New** and then repeat this process in the **Door area details** dialog. + 7. When you are done adding door areas, in the **Door area details** dialog, click **Close**. + 8. In the **Door areas** window, click **Close**. + +
Create a door area for guest room doors.

Create a door area for guest room doors.

+3. Define each set of guest room doors. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System setup** section of the left navigation pane, double-click **Doors**. + 3. In the **Doors** window, click **Add**. + 4. In the **Door details** window, select **Guest** as the door **Type**. + 5. In the **Number** field, type the door range.\ + For example: `101-109` + 6. In the **Area** field, select the guest door area that you created.\ + For example: **Guest Doors** + 7. Click **Save**. + 8. To add more door sets, click **New** and then repeat this process in the **Door details** window. + 9. When you are done adding door sets, in the **Door details** window, click **Close**. + 10. In the **Doors** window, click **Close**. + +
Create a set of guest room doors using the door area that you created.

Create a set of guest room doors using the door area that you created.

+ +*** + +## Set up Common Door Locks + +When defining common doors, make sure to choose the appropriate door type. Visionline door types include the following, among others: + +
Door TypeDescription
Guest entranceSpecify a set of guest doors to give automatic access to guests within this range. You can use this door type for common entrances.
Guest commonYou must grant access to doors of this type explicitly to specific guest credentials. You can use this door type for gym doors, parking entrances, and so on.
Elevator reader relayThis door type represents a floor button or relay within an elevator. Specify a set of guest doors to give automatic access to guests within this range. Assign each elevator reader relay to the corresponding "slot" in an elevator reader definition.
Elevator readerThe door type serves as an organization mechanism for sets of elevator reader relays.
+ +{% hint style="info" %} +For more information about door types, see the Visionline Help. +{% endhint %} + +To define a common door, first create a door area and then create a door of the appropriate type. + +1. Log in to the Visionline application if you are not already logged in. +2. Set up a door area for the group of common doors. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System setup** section of the left navigation pane, double-click **Door areas**. + 3. In the **Door areas** window, click **Add**. + 4. In the **Door area details** dialog, type a name and, optionally, a description for the new door area.\ + For example, you could create a door area named `Common Doors`. + 5. Click **Save**. + 6. To add more door areas, click **New** and then repeat this process in the **Door area details** dialog. + 7. When you are done adding door areas, in the **Door area details** dialog, click **Close**. + 8. In the **Door areas** window, click **Close**. + +
Create a door area for common doors.

Create a door area for common doors.

+3. Define each common door. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System setup** section of the left navigation pane, double-click **Doors**. + 3. In the **Doors** window, click **Add**. + 4. In the **Door details** window, select the appropriate door **Type**.\ + See the table at the beginning of this section for descriptions of some common door types. + 5. Type a **Name** for the door, reader, relay, or other entrance. + 6. For a guest entrance door or elevator reader relay, type the beginning and ending room numbers to define the associated **Room interval**.\ + Note that for guest common entrances, you set up access permissions explicitly when creating guest or other credentials. + 7. In the **Area** field, select the common door area that you created.\ + For example: **Common Doors** + 8. For an elevator reader, set the relay outputs to define the access permissions by floor or other output: + 1. In the **Relay outputs** table, select an output. + 2. Click **Select**. + 3. In the **Select elevator reader relay** dialog, select the corresponding elevator reader relay and then click **OK**. + 4. Repeat this process for any additional relay outputs. + 9. Click **Save**. + 10. To add more common doors, click **New** and then repeat this process in the **Door details** window. + 11. When you are done adding common doors, in the **Door details** window, click **Close**. + 12. In the **Doors** window, click **Close**. + +
Create one or more common doors using the door area that you created.

Create one or more common doors using the door area that you created.

diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-6-program-door-locks.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-6-program-door-locks.md index b1d7c36b9..56a1eddfd 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-6-program-door-locks.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-6-program-door-locks.md @@ -4,3 +4,146 @@ description: Learn how to program door locks for your plastic card encoding inte # Step 6: Program Door Locks +Once you have [set up door locks](step-5-set-up-door-locks.md) in the Visionline application, use the Lock Service 3G application to program the door locks themselves. When you program a lock, you download the identity and settings for the lock from Lock Service 3G to the lock. + +This process consists of the following basic steps: + +1. [Install Lock Service 3G on a laptop or tablet.](step-6-program-door-locks.md#install-lock-service-3g) +2. [Configure the Visionline application to download door lock data to Lock Service 3G.](step-6-program-door-locks.md#configure-visionline-for-lock-service-3g) +3. [Configure Lock Service 3G to connect to the Visionline server.](step-6-program-door-locks.md#configure-lock-service-3g-to-connect-to-the-visionline-server) +4. [Download door lock data from the Visionline server to Lock Service 3G.](step-6-program-door-locks.md#download-door-lock-data-to-lock-service-3g) +5. [Initialize each door lock to program it with the correct settings.](step-6-program-door-locks.md#initialize-door-locks) + +*** + +## Install Lock Service 3G + +Install the Lock Service 3G on a Windows laptop or tablet that you can move to each door lock. You use a USB-to-lock interface cable to connect this laptop or tablet to each door lock. + +{% hint style="info" %} +If the USB-to-lock interface cable does not work correctly, you may need to install the following driver: + +`CDM v2.12.xx WHQL Certified.exe` +{% endhint %} + +*** + +## Configure Visionline for Lock Service 3G + +1. Log in to the Visionline application if you are not already logged in. +2. Add a device. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System setup** section of the left navigation pane, double-click **Devices**. + 3. In the **Devices** window, click **Add**. + 4. In the **Device details** window, type a **Name** for the device, such as `Lock Service 3G`. + 5. Select **Service device host** as the device **Type**. + 6. Make sure that the **Port** is `27015`. + 7. Make sure that the **Location** is **Server**. + 8. Click **Save**. + 9. In the **Device details** window, click **Close**. + 10. In the **Devices** window, click **Close**. + +
Add a device in the Visionline app.

Add a device in the Visionline app.

+3. Obtain the registration code for the Lock Service 3G instance. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System setup** section of the left navigation pane, double-click **Service devices**. + 3. In the **Service devices** window, click **Add**. + 4. Note the registration code and validity period that the Visionline application displays.\ + You must enter this code in Lock Service 3G on the laptop or tablet. + 5. Click **OK**. + 6. In the **Service devices** window, click **Close**. + +
Obtain the registration code for Lock Service 3G.

Obtain the registration code for Lock Service 3G.

+ +*** + +## Configure Lock Service 3G to Connect to the Visionline Server + +1. On the laptop or tablet, open the Lock Service 3G application. +2. Add a server connection. + + 1. In the **Setup** section of the left navigation pane, click **Server connections**. + 2. If the **Server connections** dialog does not display automatically, click **Add**. + 3. In the **Server connections** dialog, type a **Name** for this connection to the Visionline server.\ + Note that some of the field names in this dialog are different in different versions of Lock Service 3G. + 4. In the **Address** field, type the IP address of the Visionline server. + 5. Type the **Port** number to use to connect to the Visionline server. + 6. Click **OK**. + +
Add the connection between Lock Service 3G and the Visionline server.

Add the connection between Lock Service 3G and the Visionline server.

+3. At the right of the **Lock Service 3G** window, in the lower field in the **Serial port and host** area, select the name of the Visionline server connection that you created. + +
Select the Visionline server connection.

Select the Visionline server connection.

+4. Register Lock Service 3G on the laptop or tablet. + + 1. In the **Setup** section of the left navigation pane, click **Register PC**. + 2. In the **Register PC** area, type the registration **Code** that you obtained from the Visionline application. + 3. Click **Register**. + +
Use the registration code from the Visionline application to register Lock Service 3G.

Use the registration code from the Visionline application to register Lock Service 3G.

+ + Lock Service 3G registers with the Visionline server and displays a **Registration Finished** message. +5. Click **OK**. +6. Retrieve the Visionline system ID. + + 1. In the **Setup** section of the left navigation pane, click **System ID**. + 2. In the **System ID** area, click **Get**. + +
Retrieve the Visionline system ID.

Retrieve the Visionline system ID.

+ + Lock Service 3G retrieves the Visionline system ID and then displays a **New system ID has been set** message. +7. Click **OK**. + +*** + +## Download Door Lock Data to Lock Service 3G + +1. Open the Lock Service 3G application if you have not done so already. +2. In the **Setup** section of the left navigation pane, click **Download data from server**. +3. At the right of the **Lock Service 3G** window, in the lower field in the **Serial port and host** area, select the name of the Visionline server connection. +4. In the **Download data from server** area, click **Check all**. +5. Click **Download**. + +
Download the door lock data from the Visionline server to Lock Service 3G.

Download the door lock data from the Visionline server to Lock Service 3G.

+ +Lock Service downloads the door lock data from the Visionline server and displays a message when the download is complete. + +*** + +## Initialize Door Locks + +Perform the following steps on each lock: + +1. Only if necessary, update the Lock Control Unit firmware.\ + **Test locks from ASSA ABLOY should already be preprogrammed with the correct firmware.**\ + For other locks, contact ASSA ABLOY to learn whether you need to update the Lock Control Unit firmware and, if so, to obtain the correct firmware version. + 1. Open the Lock Service 3G application if you have not done so already. + 2. In the **Initiation** section of the left navigation pane, click **Upload firmware**. + 3. At the right of the **Lock Service 3G** window, in the lower field in the **Serial port and host** area, select the name of the Visionline server connection. + 4. In the **Upload firmware** area, click **Browse**.\ + + +
Select the Lock Control Unit firmware to upload.

Select the Lock Control Unit firmware to upload.

+ 5. Select the firmware that ASSA ABLOY has sent to you and then click **Open**. + 6. In the **Available versions** table, right-click the appropriate firmware version and select **Save to database**.\ + + +
Save the firmware to the database.

Save the firmware to the database.

+ 7. In the **Available versions** table, select the appropriate firmware version. + 8. At the right of the **Lock Service 3G** window, in the upper field in the **Serial port and host** area, select the serial port that you want to use to connect to the lock. + +
Select the port.

Select the port.

+ 9. Connect the cable from the laptop or tablet running Lock Service 3G to the lock. + 10. At the bottom of the **Upload firmware** area, click **Upload**. +2. Open the Lock Service 3G application if you have not done so already. +3. Initialize the lock. + 1. In the **Initiation** section of the left navigation pane, click **Initialize lock**. + 2. At the right of the **Lock Service 3G** window, in the lower field in the **Serial port and host** area, select the name of the Visionline server connection. + 3. In the **Initialize lock** area, expand the appropriate door area and select the lock that you want to initialize. + 4. Select the **Read parameters after successful initialization** checkbox. + 5. At the right of the **Lock Service 3G** window, in the upper field in the **Serial port and host** area, select the serial port that you want to use to connect to the lock. + 6. Connect the cable from the laptop or tablet running Lock Service 3G to the lock and then click **Initialize**. + +
Connect Lock Service 3G to each lock and initialize it.

Connect Lock Service 3G to each lock and initialize it.

diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-7-create-a-production-workspace.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-7-create-a-production-workspace.md index d0a226a38..d4c7b2cdc 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-7-create-a-production-workspace.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-7-create-a-production-workspace.md @@ -6,3 +6,15 @@ description: >- # Step 7: Create a Production Workspace +Create a Seam production workspace to connect your Visionline account to Seam. You can continue to use this workspace in your production phase as well. + +1. Log in to [Seam Console](https://console.seam.co/). +2. In the upper-left corner, click the workspace switcher. + + ![Use the Seam Console workspace switcher to switch between workspaces and create new workspaces.](../../../../../.gitbook/assets/workspace-switcher.png) +3. Click **New Workspace**. +4. In the **Add a Workspace** dialog, type a name for your new workspace and your company name. +5. Disable **Sandbox mode**. + + ![To create a production workspace, disable sandbox mode.](../../../../../.gitbook/assets/add-production-workspace.png) +6. Click **Create Workspace**. diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md similarity index 100% rename from docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md rename to docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-real-visionline-server/step-8-connect-your-visionline-development-account-to-seam.md diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/README.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/README.md index 628c39c40..4e2865d9a 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/README.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/README.md @@ -6,3 +6,10 @@ description: >- # Developing Your Visionline Plastic Card Encoding App Using a Sandbox Workspace +If you do not have access to an unlicensed Visionline account, you can use a [sandbox workspace](../../../../../core-concepts/workspaces/#sandbox-workspaces) and Seam-provided virtual Visionline ACS to develop and test your Visionline plastic card encoding app. Seam sandbox workspaces provide test accounts and virtual devices and systems that you can connect and control. Importantly, virtual devices and systems behave identically to the corresponding real devices and systems. + +For detailed instructions, see the following topics: + +1. [Step 1: Create a Sandbox Workspace](step-1-create-a-sandbox-workspace.md) +2. [Step 2: Connect the Virtual Visionline ACS to Seam](step-2-connect-the-virtual-visionline-acs-to-seam.md) +3. [Next Steps](next-steps.md) diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/next-steps.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/next-steps.md index 5424817ae..e3842bda0 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/next-steps.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/next-steps.md @@ -6,3 +6,10 @@ description: >- # Next Steps +Once you've created a sandbox workspace and added a virtual Visionline ACS, proceed to the following steps: + +1. Develop your Visionline plastic card encoding app. +2. Test your app. +3. Launch your app into production. + + For details, see [Launching Your Visionline Plastic Card Encoding App to a Live Site](../launching-your-visionline-plastic-card-encoding-app-to-a-live-site/). diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-1-create-a-sandbox-workspace.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-1-create-a-sandbox-workspace.md index 74c701f39..c9fa4f9e3 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-1-create-a-sandbox-workspace.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-1-create-a-sandbox-workspace.md @@ -6,3 +6,13 @@ description: >- # Step 1: Create a Sandbox Workspace +The first step in developing and testing your Visionline plastic card encoding app using a sandbox workspace and Seam-provided virtual Visionline ACS is to create the sandbox workspace. + +1. Log in to [Seam Console](https://console.seam.co/). +2. In the upper-left corner, click the workspace switcher. + + ![Use the Seam Console workspace switcher to switch between workspaces and create new workspaces.](../../../../../.gitbook/assets/workspace-switcher.png) +3. Click **New Workspace**. +4. In the **Add a Workspace** dialog, type a name for your new workspace and your company name. +5. Enable **Sandbox mode**. +6. Click **Create Workspace**. diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-2-connect-the-virtual-visionline-acs-to-seam.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-2-connect-the-virtual-visionline-acs-to-seam.md index 785cf7c04..79e4cd4e9 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-2-connect-the-virtual-visionline-acs-to-seam.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/developing-your-visionline-plastic-card-encoding-app-using-a-sandbox-workspace/step-2-connect-the-virtual-visionline-acs-to-seam.md @@ -6,3 +6,29 @@ description: >- # Step 2: Connect the Virtual Visionline ACS to Seam +Once you've created a sandbox workspace, add a virtual Visionline ACS to start developing your Visionline plastic card encoding app. + +1. In the top navigation pane of [Seam Console](https://console.seam.co/), click **ACS Systems**. + +
Click ACS Systems to go to the Access Systems page.

Click ACS Systems to go to the Access Systems page.

+2. On the **Access Systems** page, click **New Access System**. + + Seam Console displays a Connect Webview that enables you to connect a virtual ACS to Seam. +3. In the Connect Webview, authorize the connection. + 1. Click **Continue**. + 2. If the Connect Webview displays multiple brand options, click **Visionline**. + 3. On the **Set up your Seam Bridge** page, click **Continue**. + + [Seam Bridge](../../../../../capability-guides/seam-bridge.md) is a software-only component that enables you to connect on-premises software systems to the Seam platform. Because Visionline is an on-premises ACS, Seam Bridge is required for real Visionline systems. However, this option uses a virtual Visionline ACS, so you do not need to install Seam Bridge. + 4. On the **Visionline info** page: + 1. In the **Enter your pairing token** field, type `123456` (or any six-character string). + 2. In the **Name your bridge** field, type `My Network` (or any unique string). + 3. Click **Submit**. + 5. On the **Enter your credentials** page: + 1. In the **Visionline Site Name** field, type any string to identify this virtual Visionline ACS site, for example, `My Visionline Site`. + 2. In the **Username** field, type `jane`. + 3. In the **Password** field, type `1234`. + 4. Click **Submit**. + 6. Click **Close**. + +The **Access Systems** page now displays the newly-connected virtual Visionline access control system. diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/README.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/README.md index 840d7fc42..4ae362f55 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/README.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/README.md @@ -4,3 +4,20 @@ description: Learn how to launch your Visionline plastic card encoding app into # Launching Your Visionline Plastic Card Encoding App to a Live Site +Once you have developed and tested your Visionline plastic card encoding app, you can launch your app into production using an existing live Visionline site. The instructions in this section assume that your live site already has Visionline card encoders installed and that all door locks are already set up and programmed to work with cards. + +For detailed instructions, see the following topics: + +[Step 1: Confirm That Your Visionline Site Meets the Requirements](step-1-confirm-that-your-visionline-site-meets-the-requirements.md) + +[Step 2: Configure a Visionline User Account](step-2-configure-a-visionline-user-account.md) + +[Step 3: Purchase and Import the Callback Option from ASSA ABLOY](step-3-purchase-and-import-the-callback-option-from-assa-abloy.md) + +[Step 4: Create a Production Workspace](step-4-create-a-production-workspace.md) + +{% hint style="info" %} +Skip this step if you have already created a production workspace during the development phase and want to use this workspace to launch your app. +{% endhint %} + +[Step 5: Connect Your Visionline Production Account to Seam](../../../../assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md) diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-1-confirm-that-your-visionline-site-meets-the-requirements.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-1-confirm-that-your-visionline-site-meets-the-requirements.md index 77eb4c1f4..97cba0b15 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-1-confirm-that-your-visionline-site-meets-the-requirements.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-1-confirm-that-your-visionline-site-meets-the-requirements.md @@ -6,3 +6,47 @@ description: >- # Step 1: Confirm That Your Visionline Site Meets the Requirements +Confirm that your production Visionline site meets the following system and port requirements: + +## System Requirements + +Make sure that your computer meets the following requirements: + +* Key server: + * Visionline V1.27 (or newer) + * Windows 10 1901 (or newer) + * Hosted in a location where internet traffic is allowed + +*** + +## Port Requirements + +Make sure that the following ports are unblocked on the Visionline server and client: + +### Server Ports + +* All files in the Visionline `Program Files` and `ProgramData` folders\ + The default locations are `C:\Program Files\ASSA ABLOY\Visionline` and `C:\ProgramData\ASSA ABLOY\Visionline`. +* Firewall ports: + * Port 135 (TCP) + * 3001 (TCP) + * 7799, 7788 (TCP/UDP) + * Lock Service Port (27015 default) (TCP) + * PMS port (4000 default) (TCP) + +### Client Ports + +* All files in the Visionline `Program Files` and `ProgramData` folders\ + The default locations are `C:\Program Files\ASSA ABLOY\Visionline` and `C:\ProgramData\ASSA ABLOY\Visionline`. +* Firewall ports + * Port 135 (TCP) + * 3001 (TCP) + * DCOM ports + +*** + +## For More Information + +See the following ASSA ABLOY Visionline document: + +{% file src="../../../../../.gitbook/assets/VisiOnline Server Client and DCOM Port Requirements.pdf" %} diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-2-configure-a-visionline-user-account.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-2-configure-a-visionline-user-account.md index 1cd928dc9..976186db6 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-2-configure-a-visionline-user-account.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-2-configure-a-visionline-user-account.md @@ -4,3 +4,46 @@ description: Learn how to set up a Visionline user account to integrate with Sea # Step 2: Configure a Visionline User Account +Make sure that your Visionline application is configured with an appropriate user account. You use this account to connect the Visionline instance with Seam. You can use the default `sym` username and password. + +Alternately, the Visionline ACS administrator can create a Visionline user specifically for the connection with Seam. This user must be configured as an operator that uses the System Manager operator template. This user must also have a password. + +To create a new Visionline user for the Seam connection, first create a new user. Then, configure the user as an operator that uses the System Manager operator template. + +{% hint style="info" %} +These instructions use Visionline 1.27. If you are using Visionline 1.28, you may notice differences in a few field names. +{% endhint %} + +1. Log in to the Visionline application as a user with System Manager access. +2. Create a new Visionline user. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System administration** section of the left navigation pane, double-click **Users**. + 3. In the **Users** window, click **Add**. + 4. In the **User details** window, type a **User ID** for the new user, for example, `Seam Integration`. + 5. Type the **Last name** of the user, for example, `Integration`. + 6. Type the **First name** of the user, for example, `Seam`. + 7. Select the **User group** to which to assign the user. + 8. Optionally, in the **PIN** field, type a PIN for the user. + 9. If you've added a PIN, in the **Confirm PIN** field, type the same PIN for the user. + 10. Click **Save**. + 11. In the **User details** dialog, click **Close**. + 12. In the **Users** window, click **Close**. + +
Add a Visionline user for the connection with Seam.

Add a Visionline user for the connection with Seam.

+3. Configure the new user as an operator that uses the System Manager operator template. + + 1. At the bottom of the left navigation pane, click **Lists**. + 2. In the **System access** section of the left navigation pane, double-click **Operators**. + 3. In the **Operators** window, click **Add**. + 4. In the **Operator details** dialog, click **...** next to the **User name** field. + 5. In the **Users \** window, select the user that you created and then click **Select**. + 6. In the **Operator details** dialog, select **System Manager** as the **Operator template**.\ + Alternately, you can create a new operator template for the new user, but you must make sure that this operator template has access to all permissions. + 7. In the **Password** and **Confirm Password** fields, type a password for the user. + 8. Click **Save**. + 9. In the **Operator details** dialog, click **Close**. + 10. In the **Operators** window, click **Close**. + +
Configure the new user as an operator with the System Manager operator template.

Configure the new user as an operator with the System Manager operator template.

+4. Note the username and password for this Visionline user. You must use these credentials when you [connect your Visionline account to Seam](../../../../assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md). diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-3-purchase-and-import-the-callback-option-from-assa-abloy.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-3-purchase-and-import-the-callback-option-from-assa-abloy.md index 9b5815821..dfa898b3b 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-3-purchase-and-import-the-callback-option-from-assa-abloy.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-3-purchase-and-import-the-callback-option-from-assa-abloy.md @@ -6,3 +6,19 @@ description: >- # Step 3: Purchase and Import the Callback Option from ASSA ABLOY +To launch your Visionline plastic card encoding app into production, you must purchase the Callback option from ASSA ABLOY and then import this option into Visionline. + +1. Purchase the Callback option from ASSA ABLOY. + + To purchase this option, contact ASSA ABLOY. + + Once you purchase the Callback option, ASSA ABLOY provides you with a corresponding option code. +2. Import the corresponding option code into Visionline. + 1. Open Visionline. + 2. In the top menu, click **Tools** > **Option code**. + 3. In the **Option code** field, type or paste the option code that you received from Visionline and then click **Apply**. +3. Verify that the required option has been configured. + 1. At the bottom of the Visionline left navigation pane, click **Reports**. + 2. In the **Pre-defined** section of the left navigation pane, double-click **System settings**. + 3. If desired, print or export the report. + 4. In the report, find the **`[Options]`** section and verify that the purchased option is listed. diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-4-create-a-production-workspace.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-4-create-a-production-workspace.md index 2116f17bc..8ffa88bb4 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-4-create-a-production-workspace.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-4-create-a-production-workspace.md @@ -6,3 +6,17 @@ description: >- # Step 4: Create a Production Workspace +If you did not create a Seam production workspace during the development phase for your Visionline plastic card encoding app, you must create a new production workspace to connect your Visionline production account to Seam. If you did create a production workspace already, you can choose to continue using this workspace or to create a new one. + +To create a production workspace. + +1. Log in to [Seam Console](https://console.seam.co/). +2. In the upper-left corner, click the workspace switcher. + + ![Use the Seam Console workspace switcher to switch between workspaces and create new workspaces.](../../../../../.gitbook/assets/workspace-switcher.png) +3. Click **New Workspace**. +4. In the **Add a Workspace** dialog, type a name for your new workspace and your company name. +5. Disable **Sandbox mode**. + + ![To create a production workspace, disable sandbox mode.](../../../../../.gitbook/assets/add-production-workspace.png) +6. Click **Create Workspace**. diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md similarity index 100% rename from docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md rename to docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-plastic-card-encoding-app/launching-your-visionline-plastic-card-encoding-app-to-a-live-site/step-5-connect-your-visionline-production-account-to-seam.md From daaace567cae768d8a7b117e8b25380d8814073c Mon Sep 17 00:00:00 2001 From: DebbieAtSeam Date: Thu, 22 May 2025 16:07:56 -0400 Subject: [PATCH 6/7] Fix Sensi in toc --- docs/SUMMARY.md | 4 ++-- .../step-5-program-door-locks.md | 1 - 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 7273d65d6..ff6ad31cf 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -136,7 +136,7 @@ * [Update Multiple Linked Access Codes](api/access_codes/update-multiple-linked-access-codes.md) * [Delete an Access Code](api/access_codes/delete.md) * [Pull a Backup Access Code](api/access_codes/pull_backup_access_code.md) - * [Report Device Access Code Constraints](api/access_codes/report_device_constrains.md) + * [Report Device Access Code Constraints](api/access_codes/report_device_constraints.md) * [Unmanaged Access Codes](api/access_codes/unmanaged/README.md) * [List Unmanaged Access Codes](api/access_codes/unmanaged/list.md) * [Get an Unmanaged Access Code](api/access_codes/unmanaged/get.md) @@ -317,7 +317,7 @@ * [Sandbox Salto Space Access System](developer-tools/sandbox-and-sample-data/sandbox-salto-space-access-control-system.md) * [Sandbox Schlage Encode Locks](device-guides/sandbox-and-sample-data/schlage-encode-sample-data.md) * [Sandbox Seam Bridge](device-guides/sandbox-and-sample-data/seam-bridge-sample-data.md) - * [Sandbox Seni Thermostats](device-guides/sandbox-and-sample-data/sensi-thermostat-sample-data.md) + * [Sandbox Sensi Thermostats](device-guides/sandbox-and-sample-data/sensi-thermostat-sample-data.md) * [Sandbox SmartThings Hub](device-guides/sandbox-and-sample-data/smartthings-sample-data.md) * [Sandbox Tedee Locks](developer-tools/sandbox-and-sample-data/sandbox-tedee-locks.md) * [Sandbox TTLock Locks](device-guides/sandbox-and-sample-data/ttlock-sample-data.md) diff --git a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-5-program-door-locks.md b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-5-program-door-locks.md index 67fe3cb92..57c258ce0 100644 --- a/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-5-program-door-locks.md +++ b/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/visionline-acs-setup-instructions/developing-and-launching-your-visionline-mobile-key-app/launching-your-visionline-mobile-key-app/step-5-program-door-locks.md @@ -12,7 +12,6 @@ This process consists of the following basic steps: 2. [Configure Lock Service 3G to connect to the Visionline server.](step-5-program-door-locks.md#configure-lock-service-3g-to-connect-to-the-visionline-server) 3. [Download door lock data from the Visionline server to Lock Service 3G.](step-5-program-door-locks.md#download-door-lock-data-to-lock-service-3g) 4. [Initialize each door lock to program it with the correct settings.](step-5-program-door-locks.md#initialize-door-locks) -5. *** From a673137a24a8e868104725edc3ae931f400a0a1a Mon Sep 17 00:00:00 2001 From: DebbieAtSeam Date: Thu, 22 May 2025 16:21:57 -0400 Subject: [PATCH 7/7] Fix sensi in toc --- docs/SUMMARY.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index ff6ad31cf..c4aa863e2 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -317,7 +317,7 @@ * [Sandbox Salto Space Access System](developer-tools/sandbox-and-sample-data/sandbox-salto-space-access-control-system.md) * [Sandbox Schlage Encode Locks](device-guides/sandbox-and-sample-data/schlage-encode-sample-data.md) * [Sandbox Seam Bridge](device-guides/sandbox-and-sample-data/seam-bridge-sample-data.md) - * [Sandbox Sensi Thermostats](device-guides/sandbox-and-sample-data/sensi-thermostat-sample-data.md) + * [Sandbox Sensi Thermostats](developer-tools/sandbox-and-sample-data/sandbox-sensi-thermostats.md) * [Sandbox SmartThings Hub](device-guides/sandbox-and-sample-data/smartthings-sample-data.md) * [Sandbox Tedee Locks](developer-tools/sandbox-and-sample-data/sandbox-tedee-locks.md) * [Sandbox TTLock Locks](device-guides/sandbox-and-sample-data/ttlock-sample-data.md) @@ -445,8 +445,8 @@ * [Schlage Locks](device-and-system-integration-guides/schlage-locks/README.md) * [Schlage Locks Setup Instructions](device-and-system-integration-guides/schlage-locks/schlage-locks-setup-instructions.md) * [Get started with Schlage Locks](device-guides/get-started-with-schlage-locks.md) -* [Sensi Thermostats](device-and-system-integration-guides/sensi-thermostats.md) - * [Get Started with Sensi Thermostats](device-and-system-integration-guides/get-started-with-sensi-thermostats.md) +* [Sensi Thermostats](device-and-system-integration-guides/sensi-thermostats/README.md) + * [Get Started with Sensi Thermostats](device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.md) * [Get started with SmartThings Hubs + Smart Locks](device-guides/get-started-with-smartthings-hubs-+-smart-locks.md) * [Tedee Locks](device-and-system-integration-guides/tedee-locks/README.md) * [Get Started with Tedee Locks](device-and-system-integration-guides/tedee-locks/get-started-with-tedee-locks.md)