ACAEngine -> Engine

Author: kimburgess

Diff for: administration/backoffice/README.md

@@ -1,6 +1,6 @@
 # Backoffice
 
-Backoffice is the primary admin interface used to design, manage and support ACAEngine deployments. It may be access under `/backoffice/` on your deployment. E.g.
+Backoffice is the primary admin interface used to design, manage and support Engine deployments. It may be access under `/backoffice/` on your deployment. E.g.
 
 ```http
 https://aca.example.com/backoffice/

Diff for: administration/backoffice/devices.md

@@ -1,6 +1,6 @@
 # Devices
 
-The Devices section \(1\) will list all devices that have been added to ACAEngine. This list can be filtered \(2\) by Name, IP Address or online status \(3\).
+The Devices section \(1\) will list all devices that have been added to Engine. This list can be filtered \(2\) by Name, IP Address or online status \(3\).
 
 ![](../../.gitbook/assets/image5.png)
 

Diff for: administration/backoffice/drivers.md

@@ -1,6 +1,6 @@
 # Drivers
 
-The Drivers section \(1\) will list all the drivers which have been added to ACAEngine.
+The Drivers section \(1\) will list all the drivers which have been added to Engine.
 
 Settings and a list of Devices can be viewed for each Driver by clicking on the driver name.
 
@@ -10,15 +10,15 @@ New Drivers can be added by clicking the + icon.
 
 ## Adding and Editing Drivers
 
-Upon clicking + icon, the New Driver popup will appear. ACAEngine will automatically detect the drivers available on the server and present a searchable drop down list \(1\). If the repository has been updated then a Scan for new drivers should be initiated \(2\).
+Upon clicking + icon, the New Driver popup will appear. Engine will automatically detect the drivers available on the server and present a searchable drop down list \(1\). If the repository has been updated then a Scan for new drivers should be initiated \(2\).
 
 Select a Driver to add from the list \(1\) and additional fields will appear:
 
 * Name \(2\): Devices that are an instance of this driver will appear in the device list in the format “Name - IP Address”
 * Role \(8\): Define whether the Driver should be added as a Device, Logic or Service. This should be left as default. See Key Concepts for more information
 * Description \(4\): Markdown format description of the driver. It will be inherited by all devices that are an instance of this Driver
 * Module Name \(5\): The module name defines what kind of hardware type the System Logic should treat the device as. This should be left as default. More information can be found by inspecting the Ruby code of the System Logic used
-* Default Port \(6\): Defines the default IP port on which ACAEngine should attempt to connect to all devices defined of this type. This should generally be left as default. Individual devices can still override the default defined here by defining a port for that device
+* Default Port \(6\): Defines the default IP port on which Engine should attempt to connect to all devices defined of this type. This should generally be left as default. Individual devices can still override the default defined here by defining a port for that device
 * Settings \(7\): JSON format settings that will be inherited by all devices of this type. For more information on the function of Settings and their inheritance. See Key Concepts
 
 ![](../../.gitbook/assets/image15.png)

Diff for: administration/backoffice/systems.md

@@ -40,26 +40,26 @@ When Engine is integrated with a Directory service \(e.g. Exchange Online, via G
 
 ![](../../.gitbook/assets/backoffice-system-edit.JPG)
 
-* **Name**: The name of the system \(room\) that will be shown in ACAEngine apps like the room booking panel and staff app.
-* **Email**: The mailbox that represents the room's calendar. This email address' default calendar will be queried to check which bookings exist for this room. The email address will be invited to any room bookings that a user creates from an ACAEngine app \(e.g. Staff App\). The mailbox should be confgured in the directory service \(typically Exchange online\) as a [Resource Mailbox](https://docs.microsoft.com/en-us/office365/admin/manage/room-and-equipment-mailboxes?view=o365-worldwide).
+* **Name**: The name of the system \(room\) that will be shown in Engine apps like the room booking panel and staff app.
+* **Email**: The mailbox that represents the room's calendar. This email address' default calendar will be queried to check which bookings exist for this room. The email address will be invited to any room bookings that a user creates from an Engine app \(e.g. Staff App\). The mailbox should be confgured in the directory service \(typically Exchange online\) as a [Resource Mailbox](https://docs.microsoft.com/en-us/office365/admin/manage/room-and-equipment-mailboxes?view=o365-worldwide).
 * **Support URL**: This optional link is useful for admins to click to immediately open a web app associated with the room \(e.g. booking panel or meeting room control panel\) in a new browser window.
 * **Number of Touch Panels**: This number value should be set to the total number of fixed, physical touch panels that exist for this room. This includes room booking panels and meeting room \(AV\) control panels. The number is used to calculate the number of expected incoming web connections from fixed devices to apps relating to this system. When there are less panels connected than are expected, when a warning will show on the backoffice Metrics page.
 * **Capacity**: This number indicates the number of seats that the room has. This will affect whether this room will be displayed in app search results that specify a minimum capacity.
-* **Bookable Room**: This checkbox toggles whether the room should be listed in room available search results in ACAEngine apps like the Staff App and Concierge. Only systems with this box checked will show up in search results and thus be available for users to book via ACAEngine apps.
-* **Description**: A text description for users, for keeping useful notes about the room. Does not affect any ACAEngine functions.
+* **Bookable Room**: This checkbox toggles whether the room should be listed in room available search results in Engine apps like the Staff App and Concierge. Only systems with this box checked will show up in search results and thus be available for users to book via Engine apps.
+* **Description**: A text description for users, for keeping useful notes about the room. Does not affect any Engine functions.
 * **Settings**: Any settings defined here  will be used by Devices \(Modules\) that exist in this room. Settings defined here will override any Zone or Driver settings that are inherited.
 
 ### Settings
 
-* `map_id`: If a unique ID is entered here and that ID exists as a tag on the SVG map, then map enabled ACAEngine apps will attempt to locate and pin that SVG element when requested by the user. The ACAEngine app may also change the CSS colour of that element to indicate the system's availability.
+* `map_id`: If a unique ID is entered here and that ID exists as a tag on the SVG map, then map enabled Engine apps will attempt to locate and pin that SVG element when requested by the user. The Engine app may also change the CSS colour of that element to indicate the system's availability.
 
   * Example: `"map_id": "MyOrg-AU-SYD-BLD01-99.01"`   
 
-* `allowed_groups`: An array optional of AD group names that are allowed to see and book this System in ACAEngine apps. If this setting is NOT present, then all users will be allowed to book the System.
+* `allowed_groups`: An array optional of AD group names that are allowed to see and book this System in Engine apps. If this setting is NOT present, then all users will be allowed to book the System.
 
   * Example: `"allowed_groups": "All_Admins_Group"` 
 
-* `extra_features`: A space separated list of IDs for room features can be listed here. ACAEngine apps may use this setting to know that the system has that feature
+* `extra_features`: A space separated list of IDs for room features can be listed here. Engine apps may use this setting to know that the system has that feature
   * Example: `"extra_features": "vc skype mics window dinner coffee"`
 
 

Diff for: administration/backoffice/triggers.md

@@ -1,6 +1,6 @@
 # Triggers
 
-Triggers are a way to set process automation profiles in an ACAEngine system. You can set a condition based on the available functions of any driver and set an action to any other driver or logic module.  When the condition is met, the action is triggered. Triggers can be added or removed easily and becomes a way to make simple ongoing changes to your spaces without having to write logic code.
+Triggers are a way to set process automation profiles in an Engine system. You can set a condition based on the available functions of any driver and set an action to any other driver or logic module.  When the condition is met, the action is triggered. Triggers can be added or removed easily and becomes a way to make simple ongoing changes to your spaces without having to write logic code.
 
 Triggers can be used for a mix of support actions based on device/system conditions \(EG “if the display reaches 60^C, trigger a shutdown and email support”\) and space logic \(“EG “if Sensor status is “1”, trigger air conditioning pre-set “3”\). You can stack up as many triggers in your system as you like.
 

Diff for: administration/backoffice/users.md

@@ -1,6 +1,6 @@
 # Users
 
-ACAEngine usually integrates with an external directory system \(such as Active Directory\) for authentication.
+Engine usually integrates with an external directory system \(such as Active Directory\) for authentication.
 
 The Users Section lists all users who have signed in, their level of access and a History \(log\) of the Systems which were accessed \(controlled from an Interface or viewed in Backoffice\).
 

Diff for: api/auth.md

@@ -11,13 +11,13 @@ This can either be included as an `Authorization` header \(recommended\):
 {% tabs %}
 {% tab title="HTTPie" %}
 ```bash
-http aca.example.com/api/control/systems 'Authorization:bearer <access token>'
+http example.com/api/control/systems 'Authorization:bearer <access token>'
 ```
 {% endtab %}
 
 {% tab title="cURL" %}
 ```bash
-curl -H "Authorization: bearer <access token>" aca.example.com/api/control/systems
+curl -H "Authorization: bearer <access token>" example.com/api/control/systems
 ```
 {% endtab %}
 {% endtabs %}
@@ -27,13 +27,13 @@ Or, as a query parameter:
 {% tabs %}
 {% tab title="HTTPie" %}
 ```bash
-http aca.example.com/api/control/systems bearer_token==<access token>
+http example.com/api/control/systems bearer_token==<access token>
 ```
 {% endtab %}
 
 {% tab title="cURL" %}
 ```bash
-curl "aca.example.com/api/control/systems?bearer_token=<access token>"
+curl "example.com/api/control/systems?bearer_token=<access token>"
 ```
 {% endtab %}
 {% endtabs %}
@@ -64,7 +64,7 @@ All interaction within this flow takes place within a client-side user agent, ma
 
 To authenticate you will need to direct users to the authorisation endpoint, accompanied by your registered application details.
 
-{% api-method method="get" host="https://aca.example.com" path="/auth/oauth/authorize" %}
+{% api-method method="get" host="https://example.com" path="/auth/oauth/authorize" %}
 {% api-method-summary %}
 
 {% endapi-method-summary %}
@@ -134,7 +134,7 @@ Using this flow, users first authorize your application by creating a short-live
 
 To generate the authorisation code, direct your users to the authorisation endpoint with `code` as the requested response type.
 
-{% api-method method="get" host="https://aca.example.com" path="/auth/oauth/authorize" %}
+{% api-method method="get" host="https://example.com" path="/auth/oauth/authorize" %}
 {% api-method-summary %}
 
 {% endapi-method-summary %}
@@ -190,7 +190,7 @@ This response will also include the `state` parameter if it was included in your
 
 Your backend infrastructure may then extract this and exchange it for an access token that can be used to perform actions as the authorising user by using the token endpoint.
 
-{% api-method method="post" host="https://aca.example.com" path="/auth/oauth/token" %}
+{% api-method method="post" host="https://example.com" path="/auth/oauth/token" %}
 {% api-method-summary %}
 
 {% endapi-method-summary %}
@@ -255,7 +255,7 @@ This flow should not be used as part of any components distributed to users or u
 
 This flow provides the ability to directly exchange a username and password for an access token as a single request.
 
-{% api-method method="post" host="https://aca.example.com" path="/auth/oauth/token" %}
+{% api-method method="post" host="https://example.com" path="/auth/oauth/token" %}
 {% api-method-summary %}
 
 {% endapi-method-summary %}
@@ -326,7 +326,7 @@ When receiving a token, the server response will include a token expiry - `expir
 
 Along with the `access_token`, successful authentication requests may also contain a `refresh_token`. This can be used to renew the session at any time, extending access as long as both the application registration and user are still valid.
 
-{% api-method method="post" host="https://aca.example.com" path="/auth/oauth/token" %}
+{% api-method method="post" host="https://example.com" path="/auth/oauth/token" %}
 {% api-method-summary %}
 
 {% endapi-method-summary %}
@@ -381,7 +381,7 @@ Application client secret.
 
 To end a session, applications should request a token revocation. This will invalidate the token, preventing further use.
 
-{% api-method method="post" host="https://aca.example.com" path="/auth/oauth/revoke" %}
+{% api-method method="post" host="https://example.com" path="/auth/oauth/revoke" %}
 {% api-method-summary %}
 
 {% endapi-method-summary %}

Diff for: api/control/README.md

@@ -1,10 +1,10 @@
 ---
-description: The control API provides interactions with ACAEngine core.
+description: The control API provides interactions with Engine core.
 ---
 
 # Control
 
-The control API is the primary point for querying, structuring, defining and interacting with ACAEngine deployments. The endpoints that it provides enable interaction between drivers operating on an instance and the outside world.
+The control API is the primary point for querying, structuring, defining and interacting with Engine deployments. The endpoints that it provides enable interaction between drivers operating on an instance and the outside world.
 
 The exposed capabilities are dependent on the drivers loaded to an instance. Using this API provides a high level structure for discovering this configuration and interacting with the environment that it connects.
 

Diff for: api/control/dependencies.md

@@ -1,6 +1,6 @@
 # Dependencies
 
-When a driver is loaded into ACAEngine, it becomes a _dependency_. Dependencies are available as the blueprint from which modules are created.  The `/dependencies` endpoint provide methods to discover, load and update these. For more on the role the drivers play, see:
+When a driver is loaded into Engine, it becomes a _dependency_. Dependencies are available as the blueprint from which modules are created.  The `/dependencies` endpoint provide methods to discover, load and update these. For more on the role the drivers play, see:
 
 {% page-ref page="../../key-concepts/drivers.md" %}
 
@@ -81,7 +81,7 @@ When a driver is loaded into ACAEngine, it becomes a _dependency_. Dependencies
   </tbody>
 </table>## Discovery
 
-{% api-method method="get" host="https://aca.example.com" path="/api/control/dependencies" %}
+{% api-method method="get" host="https://example.com" path="/api/control/dependencies" %}
 {% api-method-summary %}
 Search
 {% endapi-method-summary %}
@@ -154,13 +154,13 @@ Queries default to searching for any of the entered terms \(words\). A small que
 
 ## Management
 
-{% api-method method="post" host="https://aca.example.com" path="/api/control/dependencies" %}
+{% api-method method="post" host="https://example.com" path="/api/control/dependencies" %}
 {% api-method-summary %}
 Create
 {% endapi-method-summary %}
 
 {% api-method-description %}
-Defines a new dependency. The driver this references must be available on the engine nodes running this instance of ACAEngine. Available drivers can be listed by using the discovery endpoint.
+Defines a new dependency. The driver this references must be available on the engine nodes running this instance of Engine. Available drivers can be listed by using the discovery endpoint.
 {% endapi-method-description %}
 
 {% api-method-spec %}
@@ -234,7 +234,7 @@ Validation exception.
 {% endapi-method-spec %}
 {% endapi-method %}
 
-{% api-method method="get" host="https://aca.example.com" path="/api/control/dependencies/{id}" %}
+{% api-method method="get" host="https://example.com" path="/api/control/dependencies/{id}" %}
 {% api-method-summary %}
 Retrieve
 {% endapi-method-summary %}
@@ -276,7 +276,7 @@ ID of the dependency to retrieve.
 {% endapi-method-spec %}
 {% endapi-method %}
 
-{% api-method method="put" host="https://aca.example.com" path="/api/control/dependencies/{id}" %}
+{% api-method method="put" host="https://example.com" path="/api/control/dependencies/{id}" %}
 {% api-method-summary %}
 Update
 {% endapi-method-summary %}
@@ -362,7 +362,7 @@ Validation error.
 {% endapi-method-spec %}
 {% endapi-method %}
 
-{% api-method method="delete" host="https://aca.example.com" path="/api/control/dependencies/{id}" %}
+{% api-method method="delete" host="https://example.com" path="/api/control/dependencies/{id}" %}
 {% api-method-summary %}
 Delete
 {% endapi-method-summary %}
@@ -396,7 +396,7 @@ ID of the dependency to remove.
 
 ## Interaction
 
-{% api-method method="post" host="https://aca.example.com" path="/api/control/dependencies/{id}/reload" %}
+{% api-method method="post" host="https://example.com" path="/api/control/dependencies/{id}/reload" %}
 {% api-method-summary %}
 Reload
 {% endapi-method-summary %}