Overview

We're expanding the number of features that you can request audit logs for via the /api/auditlog endpoint.

We're also removing a few features that by definition will always return an empty array. While these have never been useful, there's a slight chance that some of you have implementations that expect this to happen, which may behave differently if the list of accepted parameter values is changed.

Therefore, this is classed as a breaking change ⛏️

Who will be affected

This change will affect any users or implementations that use the `/api/auditlog` endpoint to get audit logs for certain features.

Details

The /api/auditlog endpoint accepts an optional Features parameter, where you can supply a String array specifying the features that you want audit logs for. See ReDoc / Swagger for full details.

The current list of accepted values is:

AlloyUser, AlloyUserGroup, Card, Customer, Design, DesignInterface, Layer, Import, MasterSetting, MasterSetting

The values being added are:

Basemap, CustomReport, ItemForm, Mesh, AlloyRole, Workflow, WorkflowActionGroup

The values being removed are:

AlloyUser, Customer, MasterSetting

Expected Release

26th January 2023 as part of the Alloy v2.43 release.

As we reach the end of the year, it's time to look back at what we've all accomplished together in 2022. Liz and Kwarti, you can sit this one out... 😬

You loved it last year, so here it is again! We've put together a fancy webpage that you can log into to see all kinds of stats about your year in Alloy, delicately interwoven with the eccentric humour you've come to expect from us 😅

So go on, visit review2022.alloyapp.io and marvel at how busy your organisation has been this year. Feel free to share the URL of your personalised report with someone you want to impress, such as your boss or a prospective dating partner. Here's what Matthew McConaughey had to say about ours:

On behalf of the Alloy team, thanks for being with us in 2022, and we look forward to making 2023 even better 🎉

This month’s update provides a number of useful improvements across the board. The update took place during the evening of the 8th December. For a full list of changes in v2.42, please visit the Alloy Changelog.

Design/Interface Search Settings 🔍

When using the top-right Search panel to find items of a particular design or interface, there are several settings you can change to customise how searching works and how the results are displayed.

Before, these search settings were applied across all designs/interfaces. Now, they are saved per design/interface. This lets you be selective with your search customisation, so you can apply different optimisations to the designs/interfaces that are important to you.

For example, if you prefer to see Tasks sorted by their Created Time, this can now be set without affecting other designs/interfaces.

Additionally, these search settings now apply to item pickers as well, providing you with a consistent experience whenever Alloy presents you with a list of items for that design/interface.

For more details, please see this previous announcement and the Alloy User Guide.

Note: the search settings currently don't affect how Work Items or Bill Items are displayed in the Job Work Unit Editor. We're working to address this in an upcoming release.

Item Forms - New File Picker Control 📎

If you want to attach a file to an item, you no longer need to upload the file to Alloy first!

When creating/editing an item, it's now possible to upload a new file as you're configuring its Attachments attribute.

This is made possible by the availability of a new File picker control in item forms. When editing an item form for a particular design/interface, you can choose to add a File picker control for the Attachments attribute (or any Link attribute that references Files items).

When the item form is presented to a user (i.e. they create or edit an item of the relevant design/interface), selecting the File picker control will display a browsable folder structure where they can select one or more files stored within Alloy.

However, the user can also use the highlighted button to upload a new file and select it for inclusion.

Bulk Download Attachments 🖇️⬇️

When viewing an item's details, if you switch to the Attachments tab, you can now select Download all from the action bar to download all the attached files in a single zip file.

A simple but useful improvement!

Disable Module Workflows

Another simple improvement is the ability to disable any of the system workflows that appeared in your Alloy customer project after a particular module was enabled.

For example, you want to disable the Invoice Calculation workflow included with the Financial Accounts and Invoicing module because your organisation uses a custom-designed workflow instead.

When viewing the details of a workflow included with a module, you can now select Edit in the action bar and change Enabled to false, so it no longer appears in the list of runnable workflows.

Manual Workflow Output Mode

When creating a manual workflow, there's now an optional Output mode field that determines how items will be processed when the workflow is run.

The possible values are:

• Many items - all items are processed by a single workflow (used by default).
  
  
• One item - each item is processed separately by its own workflow. Slower but makes certain operations possible, e.g. if a workflow creates an invoice when supplied with an account’s Item ID, it will run once for each account, thereby generating an invoice for each one.

Alloy Mobile - iOS 16 Support 📱

In line with our policy to support the latest three versions of iOS, Alloy Mobile is now supported on iOS 16!

This means that we've performed a series of exhaustive tests on all aspects of the app running on iOS 16 and completed any work required to ensure stable operation. On this occasion, we only had to correct a couple of minor issues encountered when adding attachments to an item (such as a "Cancel" button appearing white on a white background).

As we take on iOS 16, we therefore say goodbye to iOS 13 👋. While Alloy Mobile can still be used on devices running iOS 13, the app will only be tested on iOS 14-16 from this point onwards. Therefore, if you were to encounter an issue on iOS 13, only basic troubleshooting support would be available.

Fortunately, all iOS 13 devices can be upgraded to iOS 15, therefore we strongly recommend doing so to receive the best experience going forward.

Overview

Alloy’s robust Permissions system gives you fine control over who has read/write access to most of the objects in your Alloy database (e.g. designs, layers, workflows).

To take this a step further, we introduced Access Policies. These are simple rules defined per design/interface, which ensure that users can only access items that can be traced back to them. For example, making job items only accessible to users who are members of the job’s allocated team.

While Access Policies work well in principle, the current implementation unfortunately comes with too much of a performance cost.

Therefore, Access Policies will be removed in the next Alloy release, to be replaced with a better implementation at a later date.

Who will be affected?

No active customers are currently using this feature, so we expect its removal to have zero impact.

Details

The /api/access-policy/ endpoints will be removed from the API. Any remaining access policies will be deleted.

Expected Release Date

23rd February 2023 as part of the Alloy v2.44 release.

Overview

Back in December 2021, we announced that the mechanism for API keys would be changing.

In summary, API keys would no longer be generated automatically for every user, so new API keys must be generated on demand. Additionally, these new API keys must be passed using the OAuth 2.0 Bearer token format. For full details, please see the previous New API Key Management announcement.

These changes were implemented on 13th January 2022, with the old API keys remaining valid for a year.

Therefore, this is to remind everyone that the old API key mechanism will be removed in January 2023!

Who will be affected?

Any user or integration that still uses an old API key to communicate with the Alloy APIs.

Details

As of the release date below, old API keys that were created before 13th January 2022 will no longer be valid.

Additionally, the /api/user/me endpoint (Swagger/ReDoc) will no longer include the old apiKey property in its responses.

To learn about the new endpoints for managing API keys, please see the previous New API Key Management announcement.

How can I check my API key?

The simplest way to check if your API key is "old" or "new" is to consult your code. Does it pass the API key in the OAuth 2.0 Bearer token format (RFC 6750)? If so, your API key is new!

Alternatively, you can use the GET /api/user/me endpoint (Swagger/ReDoc) before the release date to return information about the currently logged in user. If your API key matches the value of the depreciated apiKey property in the returned user, your API key is old.

If in doubt, we recommend using the POST /api/api-key endpoint (Swagger/ReDoc) to create a new API key.

Mesh Users

If you have any workflows that use a Call Mesh action, your Alloy customer project will need updating with a new API key. We've been reaching out to customers we believe to be affected by this, but if in doubt, please contact Support to request this.

Expected Release Date

26th January 2023 as part of the Alloy v2.43 release.

Overview

This is to inform all users that we've recently implemented three safety limits to Alloy’s engine.

These have been put in place to help ensure that the performance, reliability and security of Alloy remains high. Rest assured, these limits have been calculated carefully, so most users will never reach them!

In rare cases where a limit is reached, users will receive a detailed error message to inform them what has happened, so the situation can be avoided in future.

Who will be affected?

These limits affect all users of Alloy but will be unnoticeable by most.

Details

The following limits have been added.

Maximum Background Tasks

The number of background tasks that can be queued per customer project. This has been limited to 100,000 tasks, which is far higher than has ever been reached before.

If the limit is reached, attempting to create a task will fail with this error:

Error Category: ResourceLimited,  Error Code: 1657552956

Maximum Item Size

The size of any item being operated on. This has been limited to 2MB (roughly 420,000 words of text) for optimal resource management.

If the limit is reached, the operation will fail with this error:

Error Category: ItemSizeExceedLimit, Error Code: 1657279454

Maximum Items to Query in Bulk

The total number of items involved with any write operations. While a query may only affect a moderate number of items directly, each item may have child/parent items that need querying too. Therefore, this has been limited to 200,000 items on the Task Executor (75,000 items on the API services).

If the limit is reached, the query will fail with this error:

Error Category: BulkQueryLimitExceeded

Overview

When using the top-right Search panel to find items of a particular design or interface, you can customise how item attributes are searched, the collection(s) to be searched, and how the results are ordered.

However, these search settings currently apply to all designs/interfaces. This isn’t ideal, as what may be optimal for some designs/interfaces may not be optimal for others!

Therefore, as part of our continual efforts to add flexibility and improve consistency within Alloy, we’re making two important changes in this area:

• Search settings will be saved per design/interface.
  
  
• Search settings will affect item pickers as well as the Search panel.

Who will be affected?

These are broad changes that will affect most Alloy users.

Details

As before, when using the Search panel, you can customise your search settings like so:

• Select the search box, enter the name of a design/interface and press Enter.
  
  
• In the bottom action bar, select the More icon and choose Search settings.

However, when saving these settings, they will no longer be applied to all designs/interfaces. Instead, they will only be applied to the design/interface that you’re searching in.

This means you can save different search settings for different designs/interfaces, leading to a more efficient searching experience overall.

Item pickers

Search settings will be shared between the Search panel and item pickers, so saving custom settings for a design/interface in one will affect the other.

For example, imagine you’re creating a defect. In Step 2 of the procedure, you’re prompted to select the asset(s) you want to create a defect against. An item picker appears showing items of the Defects Assignable interface.

The items listed by the picker are subject to the same search settings as the Search panel. To access those settings, you can select the new cog icon (outlined in red above).

The orange dot over the icon indicates that custom settings have already been set for the design/interface being searched, which will affect the appearance and order of items shown in the picker.

Expected Release Date

8th December 2022 as part of the Alloy v2.42 release.

This month’s update provides item form improvements, the ability to attach files directly to permit applications, and a brand new map tool! The update took place during the evening of the 27th October. For a full list of changes in v2.41, please visit the Alloy Changelog.

New Measure Tool 📐

You asked for it, you’ve got it!

Alloy has a new Measure tool that can accurately measure the length between two points, the total length between multiple points, and the area of a closed shape.

It’s simple to use – just select the tool and then select two points on the map to draw a line between them. Continue selecting points to draw more lines. The length of each line is calculated and displayed in real-time, as is the total Length displayed in the bottom-left corner.

Double-select the last point to finish your initial drawing. If you do this over the first point, the Area of your closed shape will also be displayed.

You can then adjust your drawing by dragging any of its points, or adding new points along any of its lines.

This new tool will no doubt prove useful across many different service areas and reduces the need to visit sites, saving considerable time, costs and emissions.

Item Form Improvements

We’re continuing to improve the new item forms feature, which makes it possible to customise the form that users fill in when creating or editing items of a particular design/interface (introduced in the Alloy September 2022 Update).

New label property

All item form controls now have a Label property, which lets you set a display name for the control. If left blank, the attribute's name will be used.

New Multiline control

When adding a Text attribute to an item form, you can now choose a Multiline text input control. Unlike the standard Text input control, this new control can display multiple lines of text at once.

When a user selects the field on the form, a large text box will appear for them to write into.

New Super Globals

First, some background information!

We’re gradually improving support for expressions in item forms. An expression takes zero or more inputs, performs one or more logical operations, and produces one output. By utilising expressions, item forms can be context-sensitive and react to user input.

When configuring a control on an item form, you can target any of its properties to the output of a saved expression. This lets a property react to the status of other controls within the item form, e.g. make a read-only control writable if a Checkbox control is checked

Super globals are effectively system-wide variables that can be referenced in expressions. They make it possible for a property to react to the status of many other things in Alloy. For example:

• details of the current user (e.g. name, username, email address, item ID)
• details of the current item form (e.g. name, code, whether it’s operating in Create or Edit mode)
• details of the item being created/edited (e.g. item ID, design name and code, collection, parent item ID)

For a full list, see the Alloy User Guide.

This opens up all sorts of possibilities!

For example, imagine your item form has an Item picker control that displays the lookup list for a Link attribute. Using the power of expressions and super globals, it could now be configured to only list items with the same parent as the item being created/edited by the form. We know this is something many of you have wanted for a while!

While expressions remain developer-focused for now, this is an important part of ongoing efforts to develop the feature. We plan to make expressions available to a wider audience when we release a user-friendly expression builder in the not-too-distant future.

Indicate Required Attributes *️

Previously, when creating/editing an item, Alloy displayed all of the required attributes and hid the others behind a Show Options button. With the introduction of item forms, this behaviour has had to change.

Therefore, Alloy now marks any required attribute with an orange asterisk. This happens automatically, regardless of whether an item form is created for a design/interface or not.

Attachments for Permit Applications📎

For Street Works users, applying for permits is a regular procedure. Permits often require supporting documents and photos. While permits can have file attachments, you could only add them after the permit was created. This was a bit of a hassle!

Therefore, we’ve now added an optional Attachments step to the permit application itself, so you no longer have to spend extra time attaching files afterwards.

New Rounds setting on Alloy Mobile Android

In response to customer feedback, we’ve added a new Go to rounds on login setting to Alloy Mobile on Android.

If enabled, the app will automatically show the Rounds panel after logging in. This happens immediately, so you don't need to wait for the automatic sync to finish (your Rounds will refresh afterwards).

This will be especially useful for vehicle-based users who seek to minimise time spent between tasks.

Overview

We recently added several Applicable Type endpoints to the Web API: https://announcements.alloyapp.io/applicable-types-now-enforced-by-web-api-3jpgbe

Applicable Types define how items of various activity-related designs can link to each other, e.g.

• Which Asset types can each Job/Inspection/Defect type be linked to?
• Which Job types can each Job Work Unit type be linked to?

When using the api/applicable-type/applicable-from endpoint, you may receive some unexpected results. Put simply, this is because the current logic is finding links that can be applicable but haven’t explicitly been made applicable.

To improve this, we’re changing how the endpoint behaves. Rather than accepting a list of designs, it will instead accept a list of items. The new logic will be able to use the parent or child items to determine which DoDIs or items are applicable from that item.

This should produce results that are more in line with expectations! However, it will require some breaking changes. 😐

Who will be affected?

These breaking changes will affect anyone who uses the ApplicableTypes endpoints on the Web API.

Details

New Endpoint Addresses

The addresses of the following endpoints will be changing.

List Applicable From Types endpoint

The request for this endpoint (ApplicableTypeFromWebRequestModel) will be changing:

• The toAll property will be removed.
• The from property will no longer accept a ApplicableFromItemWebModel (item IDs) and therefore will no longer require a discriminator. It will only accept ApplicableFromDodiWebModel (DoDi codes).
• The toAllItems required property will be added (to replace toAll). This is an array of item IDs that you wish to check.
• The filterAttributeCode required property will be added. This specifies the link attribute to find applicable types on. The attribute must be present on all the items provided in toAllItems.

For example, to query which job types can be raised against specific assets, you would provide these values for the aforementioned parameters:

• ToAllItems = an array of asset item IDs
• FilterAttributeCode = attributes_tasksAssignableTasks
• From = designInterfaces_jobs
  (to exclude inspections and other task types)

Additionally, the response model for this endpoint (ApplicableTypeFromWebResponseModel) will also be changing:

• The NoRestrictions property will be added.  If no results are returned, this boolean explains why. If true, there are no restrictions, which means everything applies. If false, it means that nothing applies.
• The results can be of type ApplicableFromDodiWebResponseModel or ApplicableFromItemResultWebModel, so these are the new discriminators to use (no more ApplicableItemWebModel).

Importantly, this revised endpoint won’t support finding applicable job types for supplied work unit items. This will be handled by a new endpoint coming in future.

List Applicable To Types endpoint

The response for this endpoint will be changing:

• The results can only be of type ApplicableToDodiWebResponseModel. Therefore, it will no longer be necessary to supply a discriminator.

Expected Release

8th December 2022 as part of the Alloy v2.42 release.

The documentation available on Swagger and ReDoc will be updated accordingly.

Overview

This is a follow-up to a recent post about an issue affecting the import of geometry data in Alloy Web.

The issue was caused by a third-party service (espg.io), which provided Alloy with a list of Coordinate Reference Systems (CRS) and the corresponding proj4 strings required for converting the incoming geometry data accordingly. Upon discovering the issue, we quickly issued a temporary workaround.

To avoid this situation repeating in future, we’ve now removed this dependence from Alloy in favour of a curated local list.

Who will be affected?

This change affects all users who use Gateway to import geometry data in Alloy Web.

Details

When configuring an import in Alloy, there are two optional steps in the procedure that involve imported geometry:

• Attributes – in this step, you can map headers in the incoming data to attributes on the selected design. After selecting a GeoJSON attribute, you can select the Coordinate System field and choose one from the list (see below).
  
  
• Geometry – in this step, you can specify the type of geometry data to be imported. After selecting a Type, you can select the 🔍 icon in the Coordinate System field and choose one from the list (see below). Unlike the previous step, the full proj4 string will appear in the field, so it can be edited if necessary before selecting Done.

The coordinate system will default to WGS84 Lat/Lng if not explicitly set.

If you have any existing imports that include geometry data and have a Status of Configured or Validated, we recommend reconfiguring them. To do this, open the import item, select More in the bottom action bar and choose Reconfigure.

Available Coordinate Systems

We’ve included the most popular coordinate systems to choose from. Any others we should add? Please feel free to contact Support with your suggestions!💡

OSGB36 / British National Grid
SRID:27700
+proj=tmerc +lat_0=49 +lon_0=-2 +k=0.9996012717 +x_0=400000 +y_0=-100000 +ellps=airy +towgs84=446.448,-125.157,542.06,0.15,0.247,0.842,-20.489 +units=m +no_defs

WGS84 Metres
SRID:3857
+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0 +k=1.0 +units=m +nadgrids=@null +wktext  +no_defs

WGS84 Lat/Lng
SRID:4326
+proj=longlat +datum=WGS84 +no_defs

NZGD2000 / New Zealand Transverse Mercator
SRID:2193
+proj=tmerc +lat_0=0 +lon_0=173 +k=0.9996 +x_0=1600000 +y_0=10000000 +ellps=GRS80 +towgs84=0,0,0,0,0,0,0 +units=m +no_defs

Expected Release

Due to this new feature’s importance, it was hotfixed into the current Alloy v2.40 release on 17th October 2022.