Install
Works with Drupal: ^11.4 || ^12Using Composer to manage Drupal site dependencies
Alternative installation files
Download tar.gz
3.9 MB
MD5: 1fe255c82623c88580a1544ae369b761
SHA-1: 82385a54c9ba20d954897e638a5e44d117439283
SHA-256: 62ee08682652ec2fe09baf8b9fbc5db9e525bc6ea5f7ace817b632c24ae715ba
Download zip
5.6 MB
MD5: 8760fb61173da1bf8df81261ea0ca31b
SHA-1: dabdc676fb475c71800d44d421a613be1081336d
SHA-256: 2850f4f92f9ab3b86c664ce970e6a5d5847d369ef8372d210519ad4cecfaac48
Release notes
WARNING: THERE IS NO MIGRATION PATH. YOU MUST REINSTALL FROM SCRATCH.
Do not update an existing site to this release. Orchestra ships no update hooks, and none is coming until the first beta release. A site on an earlier alpha holds a database and configuration this code does not match.
Uninstall the Orchestra modules, drop what they leave behind, and install 1.0.0-alpha29 fresh. Every instance, token, task, incident, variable, attachment and delegation from an earlier alpha is lost, and that is expected.
Requirements
- Drupal 11.4 or later (
^11.4 || ^12). The Drush commands are now console commands, which core builds from 11.4 on, so they run with Drush 15 as well as Drush 13 and 14. #3635499
New
- Pause new instances. A site-wide switch refuses every new instance (the start button, the API and MCP tools, webforms, event and scheduled starts) while the running ones finish: their steps, timers, events and subprocess children go on. Callers are told the site is paused, with the expected end when one is given. See the new Pausing documentation page. #3635492
- A step waits for a service that is temporarily down. An audience reading an organization directory, or an HTTP request answered with no response, a 429, 502, 503 or 504, no longer stops the step on an incident. The step runs again by itself after a delay (5 minutes by default, or what the service asked in
Retry-After), with no attempt counted, and stops on an incident only once the outage has lasted past a limit (1 day by default). Both are site settings. Notifications and timers wait the same way. See the new Service outages documentation page. #3635517, #3635522 - A step can be offered to an email address before its account exists. On a site that creates accounts at first login, by single sign-on for example, and says it provisions them by email, a step offered to an address with no account waits for it: the address is notified at once, and the account created at first login finds the step in its inbox. #3635516
- Workflow and tenant Texts. A workflow and a tenant can define their own translatable Texts, edited from a Texts operation and translated on their Translate tab. Templates read them as
[orchestra:workflow-text:NAME]and[orchestra:tenant-text:NAME], in the reader's language. In an embedded child, a workflow Text is looked up in the steps that call it first, so a parent can reword its child. #3635512, #3635513 - A step can give its status a label of its own. The status keeps its meaning for filters, the API and parent workflows, while the requester reads the step's wording in My requests and on the instance page. #3635511
- The modeler warns about steps no branch can reach, naming them, so a missing flow is seen before the workflow runs. #3635508
- Link lifetimes are site settings. A default (30 days) and a maximum (90 days) for the links a step sends. A payment's return address lasts until the payment's deadline plus a day, within the maximum. #3635495
- A payer who chose a bank transfer is told what is expected and by when, with a link back to the payment's instructions, instead of being offered the payment options again. #3635489
- The instance list marks an instance whose embedded child runs an older version as N (partial), and still offers to migrate it. #3635520
Fixes worth naming
- A busy lock no longer halts a step another worker is running. Waiting for the lock was counted as a failed attempt, so a slow step could be moved to error while it was still running, and an operator's retry then ran its work twice. #3635500
- Completing a task advances only that request's own instance. It also advanced other people's instances, from any tenant, as the person completing the task: a subprocess set to give its child to the current user gave it to them. #3635500
- Access fixes. A payer can no longer skip a payment step through their own link. A task offered to everyone needs process orchestra tasks to be completed through its operation page or the API. Reassign orchestra tasks reads an instance only while one of its steps is held. A step assigned to an email address no longer goes to whoever registered that address as their username. Saving a tool step that runs as another account needs administer orchestra. #3635500
- An unreadable payment amount no longer reads as "nothing to pay", which at a settle step released the payer's hold with nothing collected. #3635500
- A running instance cannot be deleted, whoever asks: a form, a bulk action, the API or code. Cancel it first. #3635491
- Emails are in each recipient's language. A task or step email linked every recipient to the inbox in the language of whoever caused it, and named the waiting step in that language. A reminder's note was in the language the timer fired in. Each recipient now gets the whole email, links included, in their own language. #3635502, #3635503
- A reminder's note has its tokens replaced, in the inbox email and in the message an ECA model reads. #3635515
- Saving a workflow's or a tenant's Texts or initial variables keeps what changed meanwhile, such as nodes edited in the modeler in another tab. #3635515
- Go straight to the gateway skips the payment summary only when exactly one account can take the payment. It could send a payment to an account that could not take it. #3635496
- A payer can be handed off to a payment held on another site. #3635493
- Uninstalling Orchestra leaves no queued notifications or notices behind, nor the drain key. Installed again, a site would have sent an old notification about a new instance that got the same id. #3635521
- Orchestra no longer changes the French of core's common words. Words it uses in its own sense (From, To, Enabled, Current, All, Redirect...) now carry a translation context. #3635506
Changed
- Node Values are now called Texts, with the workflow and tenant ones: tokens
[orchestra:node-text:NAME],[orchestra:workflow-text:NAME]and[orchestra:tenant-text:NAME], configuration keytexts. A reminder's note is now one of its step's Texts. #3635514, #3635503 - A step's timeout and its timers are one list of timers, each with its own deadline, action and optional repeat. The step's deadline is the earliest timer that ends the step. #3635498
- A payment step needs a limit: a timer that ends the step, or a payment timeout. One with neither waited for the payer forever. #3635490
- Steps run from their active tokens rather than from core's queue: cron, the drain endpoint, Run pending steps and synchronous requests take the due steps from the engine's own table, each under a lease. The
orchestra_advancequeue is gone. The drain endpoint's report now sayssteps_run,handlers_sent,steps_leftandtimers_fired. #3635519 - The unreachable task sweep is budgeted by the people it asks about, not by 100 tasks per run, so tasks offered to a few roles are checked several hundred at a time. #3635518
- The most branches per split must be a number: "no limit" is gone. #3635501
- Names in settings are stored without surrounding spaces, whether saved from a form, the modeler or a configuration import. #3635494
- The payment example's end steps say what happened. #3635497
For theme developers
- Easy Email templates read
node_texts,workflow_textsandtenant_texts. #3635514
For module developers
- Throw
ServiceUnavailableException, or your own class implementingServiceUnavailableExceptionInterface, when a service a step needs did not answer. Itsretry_delayargument andgetRetryDelay()carry how long the service asked to wait. #3635517 UserProvisioningInterfacegainscanProvisionWithEmail(). An audience of people who may not have logged in yet extendsUserAudienceWithProvisioningBaseand returns user IDs, usernames or addresses. #3635516WorkflowEngineInterface::REFUSAL_PAUSEDis the start refusal while new instances are paused. #3635492StepDrainerruns the due steps.AdvanceQueueDrainer,WorkflowEngineInterface::QUEUEandadvanceQueued()are removed. #3635519LanguageSwitcherInterface::executeInLanguage()runs work in a language, as notifications now do for each recipient. #3635502- Configuration schema type
orchestra.string_trimmedstores a string without surrounding spaces. #3635494 - Renamed:
Recipient::createFromAccount()andcreateFromContact(),RemoteChildKey::getFirstChildKey()andgetReplacementKey(). #3635507 - The Drush commands live in
src/Commandas Symfony console commands. #3635499
For translators
- Common words Orchestra uses in its own sense now carry a translation context (Workflow flow, Delegation, Webhook, Remote site, Workflow version, Access, Condition, Workflow component, Interaction), so their translations need redoing under it. The French translation shipped with the module is up to date. #3635506