Deeper Understanding

Round-trip write-back for grouped Safran schedules

Modified on Thu, 12 Nov at 1:13 PM

TABLE OF CONTENTS

  1. Introduction
  2. What this applies to
  3. Before you start
  4. The grouped schedule you write back to
  5. Set up the write-back agreement
  6. Only Include Specified Mappings
  7. How write-back behaves
  8. Safran project settings are checked first
  9. What is and is not written back
  10. Conflicts, removals and safety
  11. Constraints and limitations
  12. Messages in the transfer log
  13. Avoiding common errors
  14. Related guides

Introduction

A round-trip sends your Safran data out to another system, lets it be updated there, and then writes the changes back into your own Safran projects — automatically, into the exact project each activity came from.

This builds on a virtual schedule — the grouped schedule that bundles several Safran projects into one, described in Writing out of Safran. On the way out, that group is sent as one package. On the return leg, SchedEx takes the data that comes back and routes each activity into the exact source project it originally came from.

Warning: A round-trip writes to your live Safran projects. Unlike a one-way transfer to a partner, it changes your own schedules. Read Conflicts, removals and safety before you activate one, and keep Only Include Specified Mappings on unless you specifically want core fields overwritten.


What this applies to

It applies to Detail
Write-back target A Safran virtual schedule on the return leg.
Source and target The same virtual schedule for both the send-out and the write-back.
Intermediary system The first-leg destination — Safran, P6, ILAP Analytics, or any supported scheduling system.
Grouping method Enterprise-field queries only. Grouping by project group is planned for a future release.

Before you start

A write-back agreement can only be saved when all of these are true. If one is missing, SchedEx blocks the save and shows the message in the table.

Condition Message if it is not met
The receiving connector is Safran "Only Safran connectors can receive data into a virtual schedule. Select a schedule that is not virtual."
Frequency is Predecessor Exchange Agreement, with a predecessor selected "This exchange agreement receives data into a virtual schedule. Set the frequency to 'Predecessor Exchange Agreement' and select a predecessor. Only the owner can change the frequency."
The predecessor sends from Safran "The predecessor exchange agreement must send data from Safran. A virtual schedule can only receive data back into the Safran projects that sent it."
The virtual schedule is on the connector the predecessor sends from "The virtual schedule must be on the connector that sends the predecessor exchange agreement's data. Select a virtual schedule from that connector."
The virtual schedule is the one the predecessor sends from "Select the virtual schedule that the predecessor exchange agreement sends from. The data can only go back to the projects that this schedule sent."

A second connector to the same Safran server does not count as the same connector: the write-back finds the original projects through the sending connector's records.

Note: If you are the partner and select a virtual schedule before the owner has set the frequency, the wizard shows "You selected a virtual schedule. It can only receive data when this exchange agreement runs after a predecessor. Ask the owner to set the frequency to 'Predecessor Exchange Agreement' and save. Then select this schedule again."

Client versions. Beyond these save rules, running the write-back needs an up-to-date client:

Step Desktop Client / Autonomous Component
Send the group out 2.15.0.0 or later — 2.17.0.0 or later if the virtual schedule has no code set
Write back into the group 2.17.0.0 or later

An older receiving client is refused with "Downloading into a virtual schedule requires client version 2.17.0.0 or later. Please update your client. If the issue persists, contact support."


The grouped schedule you write back to

The write-back target is the same virtual schedule you send out — created and managed on the Safran connector's Persisted Data → Schedules tab. You can recognize it by its Virtual chip and a Schedule ID that starts with Virtual_ (for example Virtual_21081); it has no start or finish date of its own. The same chip appears on the Config's Schedule tab and on the agreement's Schedule identifier, so you can confirm the receiving side really is the virtual schedule.

A virtual schedule in the connector's schedule list: (1) the Virtual chip, (2) the actions menu with View Details, Edit and Delete.

Open its View Details to confirm the group: the host fields, the grouping filter, and the projects it currently matches.

Virtual Schedule Details: (1) the host fields, (2) the grouping filter, (3) the projects it matched at the last persist.

SchedEx uses this same grouping filter on the return leg to decide which project each returning activity belongs to. It matches the filter live in Safran at transfer time, so the projects written to can differ from the list above until you persist the connector again.

To create or change the group, use New Virtual Schedule on the same tab — see Writing out of Safran. Since SchedEx 2.18.0.0, a virtual schedule can be created without a code set; its projects can then use different code sets.

The connector's Schedules tab: (1) New Virtual Schedule, (2) Hide virtual schedules.


Set up the write-back agreement

Configure these on the follow-up (write-back) Exchange Agreement — the one that runs after the send-out agreement:

  1. Frequency = Predecessor Exchange Agreement. The owner sets the frequency and selects the send-out agreement as the predecessor. This chains the write-back to run straight after the data goes out and comes back.
  2. Receiving schedule = the virtual schedule the predecessor sends from, on the same Safran connector.
  3. Keep Only Include Specified Mappings on. It is on by default for a write-back. See Only Include Specified Mappings before turning it off.
  4. Set your conflict option. Choose how the agreement resolves conflicts before activating — it applies to every project in the group (see Conflicts, removals and safety).

Tip: If Save is blocked, read the message — see the table in Before you start. Most often the frequency is not set to Predecessor, or the virtual schedule is not the one the predecessor sends from.


Only Include Specified Mappings

This setting controls how much of each activity the write-back is allowed to change in your live Safran projects. SchedEx turns it on by default when an agreement writes back into a virtual schedule — you can accept that default (recommended) or turn it off.

Setting Behavior
On (default) Only the fields you explicitly mapped are written back. All other fields in the Safran projects are left unchanged. This is the safest choice for editing a live source.
Off Core fields (dates, codes, built-ins) are written in addition to your mappings.

When you turn it off, SchedEx asks straight away: "Turn off 'Only Include Specified Mappings'?" — "This agreement sends data back to the projects in a virtual schedule. We recommend that you keep this setting on. Then the transfer changes only the mapped fields. Do you want to turn it off?" Select Turn off to confirm.

Codes. With the setting on, an activity's code changes only if you mapped the code. With it off, code changes flow back to the source. Whenever a code is written back, the grouping prefix added on the way out — for example 500_112 — is stripped back to the real source code, 112.


How write-back behaves

On each run, SchedEx:

  1. Reads the current Safran projects live and matches them against the grouping filter.
  2. Checks the Safran project settings of every matched project, before anything is written (see Safran project settings are checked first).
  3. Routes each returning activity back to its originating project, matched through SchedEx's reference data rather than by code.
  4. Restores the original code by removing the grouping prefix.
  5. Skips any project that no longer matches the filter (or no longer exists), and notes it in the transfer log.
  6. Checks conflicts per project, using the single agreement-level conflict option, and then writes to each project.

Because the match is on reference data, an activity returns to the correct project even if two projects happen to share the same code. The log names each project it writes to, for example "Writing the data back to 3 project(s): 101, 102, 103."


Safran project settings are checked first

Before anything is written, SchedEx checks the Safran Project Properties of every project in the group. All projects with a problem are reported together, so you can fix them in one go — no project is written to while one of them has a setting that stops the transfer.

Safran setting When it is wrong
Allow progress to decrease is off The transfer stops. Turn the setting on in Safran.
The project allows scope changes only through Variation Orders (VOs) The transfer stops. SchedEx does not pass VO information, so turn this off in Safran.
Auto Sum is off A warning only: values summed from resource assignments up to activities may not be correct.

The same check runs on the way out, for the projects that are sent: Save calculated dates to database must be on (otherwise the transfer stops), and Auto Sum off gives a warning.


What is and is not written back

Object Behavior
Activities Routed to their originating project; the grouping prefix is stripped from the code.
Resource assignments Travel with their activity; new assignments on existing activities are included.
Resources, calendars, profiles Existing entries are updated; new ones are not created.
Structures / code sets Each project's existing structures are updated within that project.
Links / successors Links within a project are written (new ones included). Links between two different source projects are skipped.

Not written back — each is listed in the transfer log as a warning:

  • New activities created at the intermediary. They have no source project, so they and their resource assignments are not created in Safran.
  • New resources, calendars, profiles or structures created at the intermediary. A write-back only updates what the projects already have.
  • Resource assignments that use a resource that was not transferred, and links that point at an activity that was not transferred.
  • Cross-project links. A link between activities from two different source projects cannot live in a single Safran project.
  • A profile from another project's profile set. If a resource assignment comes back with a profile that is not in its own project's profile set, the assignment is written but its profile is left unchanged.
  • Projects that left the group. A project whose grouping value changed, or that was deleted in Safran, is skipped.

How each code set, calendar, resource and profile is handled

On the way out, same-named code sets, calendars, resources and profiles from the grouped projects are combined into one package (see Different code sets, calendars, resources and profiles in Writing out of Safran). On the way back, SchedEx updates the matching existing item in each project and leaves brand-new shared objects out — a new shared object has no source project to return to:

In the returning data On write-back
Coding fields / code sets (structures) Each project's existing structures are updated within that project. Code fields or values that were created only at the intermediary are not added to Safran.
Calendars Existing calendars are updated. A write-back does not create calendars.
Resources Existing resources are updated. A write-back does not create resources.
Profiles Existing profiles are updated, within each project's own profile set. A write-back does not create profiles.

So a round-trip keeps your shared libraries — calendars, resources, profiles and code sets — in step by updating them, but it never introduces a brand-new shared object into Safran from the intermediary. If you need a new calendar or resource in the source, add it in Safran directly.

Note: A group may contain projects that use different code sets. On write-back, each project's own structures are updated within that project, so mixed code sets are handled correctly per project.


Conflicts, removals and safety

Write-back follows SchedEx's normal Safran download rules, applied per project:

  • Before anything is written, SchedEx checks that every returning activity and shared object can be placed in exactly one project. If an activity exists in more than one project of the group, or a calendar, resource, profile or structure has a different Safran ID in each project, the whole transfer stops and no data is transferred. See Messages in the transfer log.
  • Objects with independent changes in the source are resolved using the single agreement-level conflict option, applied the same way to every project in the group.
  • Removals follow normal download behavior.
  • If a conflict is not resolved, nothing is written to any project. Resolve the conflict and run the transfer again.

Warning: A round-trip writes to your live source. Unlike a one-way transfer to a partner, it changes your own Safran projects. Keep Only Include Specified Mappings on unless you specifically want core fields overwritten, and confirm your conflict option before activating.


Constraints and limitations

Area Constraint
Write-back target A Safran virtual schedule only.
Grouping Enterprise-field queries only (project-group grouping is planned).
Schedule / connector The first-leg source and the write-back target must be the same virtual schedule on the same connector.
Predecessor Required. A write-back cannot be standalone or clock-scheduled; it runs after its predecessor.
Client version 2.17.0.0 or later for the client that writes back.
Cross-project links Links between activities in different source projects are skipped with a warning.
New shared objects Calendars, resources, profiles and structures are updated, never created.
No matching projects If no project matches the filter, nothing is written and the log says so.

Messages in the transfer log

Always check the transfer log after a write-back run. In the messages, {count} is a number and … is a list of the activities, links or objects concerned.

Messages that stop the transfer (no data is transferred):

Message Meaning
"No destination project matches the grouping filter of the virtual schedule, so there is nowhere to write the data. No data was transferred. Check the grouping filter values, and check that the projects have these values in Safran." No project currently matches the filter.
"… returned no projects for the connector, so the projects of the virtual schedule could not be found. No data was transferred. Check that the connector can still read its projects, then run the transfer again." The connector could not read any projects from Safran.
"These activities exist in more than one project of the virtual schedule, so the transfer cannot tell which project to update: … No data was transferred. This can happen when projects are copies of each other. Give these activities unique codes, or remove the copied projects from the grouping filter." An activity is ambiguous across projects — usually because two projects are copies.
"These calendars, resources, profiles or structures have a different Safran ID in each project of the virtual schedule, so the transfer cannot tell which one to update: … No data was transferred. Contact support." A shared object resolves to different Safran objects across the projects.
"The calendar, resource and profile sets of these projects could not be read from Safran, so the transfer cannot tell which objects belong to them: … No data was transferred." SchedEx could not read which sets the projects use.
A Safran project-settings message, for example "The destination Safran schedule does not allow decreased progress. …" A project in the group has a setting that stops the transfer — see Safran project settings are checked first.

Warnings (the rest is written as usual):

Message Meaning
"{count} activities belong to projects that are no longer part of the virtual schedule. They and their resource assignments were not transferred: … The other projects were transferred as usual. Add the projects to the grouping filter again if you still want to update them." Some activities came from projects that dropped out of the group.
"{count} activities do not belong to any project of the virtual schedule, because they were created in the sending schedule. They and their resource assignments were not transferred: …" New activities from the intermediary are not created in Safran.
"{count} calendars, resources, profiles or structures do not exist in any project of the virtual schedule. A write-back only updates what the projects already have, so these were not created: …" New shared objects from the intermediary are not created in Safran.
"{count} resource assignments use a resource that was not transferred, so those assignments were not transferred either." Assignments that need a resource that was left out.
"{count} links point at activities that were not transferred, so those links were not transferred either." Links to activities that were left out.
"{count} links connect activities in different projects. A Safran link must stay inside one project, so these links were not transferred: …" Cross-project links are skipped.
"{count} resource assignments use a profile that is not in the profile set of their project, so the profile of these assignments was not changed: …" The assignment is written, but keeps its current profile.

Avoiding common errors

If you see… It means… Do this instead
Save is blocked on the agreement One setup rule is not met Read the message and check the table in Before you start.
"Downloading into a virtual schedule requires client version 2.17.0.0 or later. …" The receiving client is older than 2.17.0.0 Update the Desktop Client / Autonomous Component to 2.17.0.0 or later and run again.
A Safran project-settings message, and nothing was written A project in the group has Allow progress to decrease off, or allows scope changes only through VOs Fix the setting in each project the message names, then run again.
A project was not written back It no longer matches the filter, or was deleted Check the log; persist the connector and confirm the project still matches the group.
"These activities exist in more than one project …" Two projects in the group are copies of each other Give the activities unique codes, or remove the copied projects from the grouping filter.
"These calendars, resources, profiles or structures have a different Safran ID in each project …" A shared object resolves to different Safran objects across projects Contact support.
A link went missing at the source It linked two different source projects Cross-project links are skipped by design; keep such links inside one project if they must survive the round-trip.
Core fields changed unexpectedly in Safran Only Include Specified Mappings is off Turn it back on so only mapped fields are written.
Nothing was written at all No projects matched the grouping filter this run Check the filter and persist the connector again; the log says "No destination project matches the grouping filter …" when none qualify.
"Virtual schedule transfer stopped: schedules with ids … contain … a single identity across them …" (on the send-out) Two projects in the group are copies of each other and share objects already transferred Narrow the grouping filter to include only one of those projects, or use an activity filter so each duplicated activity is in only one project, then run again.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article