You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Update examples to bold terms consistently
The following terms are identified here and bolded:
- flow
- flow definition
- flow run
- run
- state (in a flow)
- collection (GCS/Transfer)
Notable variations on this:
- In some contexts, we write "Guest Collection" -- these are left
as-is for now, with no boldfacing.
(Should it be `**guest collection**`?)
- `Globus-provided Flow` has converted to
`Globus-provided **flow**`
- We write `**run** ID`, rather than `**run ID**` or similar.
* Apply suggestions from code review
Co-authored-by: Kurt McKee <contactme@kurtmckee.org>
---------
Co-authored-by: Kurt McKee <contactme@kurtmckee.org>
Copy file name to clipboardExpand all lines: transfer_examples/transfer_after_approval/README.adoc
+20-19Lines changed: 20 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,12 +5,12 @@
5
5
Allow users to submit an approval request to transfer a file to a destination Guest Collection.
6
6
7
7
The request will come in the form of emails to curators who are authorized to approve the transfer.
8
-
If approved, the file will be transferred using the flow's own identity -- not the user's --
9
-
ensuring that users do not need permission to read or write to the destination collection.
8
+
If approved, the file will be transferred using the **flow**'s own identity -- not the user's --
9
+
ensuring that users do not need permission to read or write to the destination **collection**.
10
10
11
-
Users who run the flow will not be informed who the curators/approvers are,
12
-
nor will they be informed by the flow itself where the file is transferred to.
13
-
They only need to know that "this flow allows you to submit a file for transfer."
11
+
Users who run the **flow** will not be informed who the curators/approvers are,
12
+
nor will they be informed by the **flow** itself where the file is transferred to.
13
+
They only need to know that "this **flow** allows you to submit a file for transfer."
14
14
15
15
Example uses include:
16
16
@@ -23,46 +23,47 @@ This flow has several technical highlights.
23
23
24
24
* `__Private_Parameters` and `_private` parameter prefixes are used throughout.
25
25
This helps restrict visibility of private information (such as email addresses and SMTP credentials)
26
-
when users view the flow definition as well as while the flow runs.
26
+
when users view the **flow** definition as well as while their **runs** of the
27
+
**flow** are executing.
27
28
+
28
29
For more information, see link:https://docs.globus.org/api/flows/authoring-flows/secrets/[Protecting Secrets]
29
30
in the Authoring Flows documentation.
30
31
31
-
* By setting the `RunAs` value in the `TransferFile` state,
32
-
the transfer operation will be performed using the flow's own identity
32
+
* By setting the `RunAs` value in the `TransferFile` **state**,
33
+
the transfer operation will be performed using the **flow**'s own identity
33
34
to access the destination collection.
34
-
This allows the flow to be made public -- and run by any user --
35
-
without having to give individual users write permission on the destination collection.
35
+
This allows the **flow** to be made public -- and run by any user --
36
+
without having to give individual users write permission on the destination **collection**.
36
37
37
38
== Prerequisites
38
39
39
-
The flow definition must be modified before using it to create a new flow.
40
+
The **flow** definition must be modified before using it to create a new **flow**.
40
41
It also has several requirements when running.
41
42
42
43
=== Modification requirements
43
44
44
-
* The `SetupEmailLoop` state must be modified.
45
+
* The `SetupEmailLoop` **state** must be modified.
45
46
The email addresses of approvers must be updated, and unique IDs must be assigned to each reviewer.
46
47
Finally, the `loop_end` value must be updated to match the number of approvers.
47
48
48
-
* The `SendEmail` state must be modified.
49
+
* The `SendEmail` **state** must be modified.
49
50
Specifically, the SMTP hostname, username, and password in `send_credentials` must be updated,
50
51
as well as the email address in `sender`.
51
52
+
52
53
It is also possible to use an AWS SES credential for sending emails.
53
54
See link:https://docs.globus.org/api/flows/hosted-action-providers/ap-notification-notify/[the Notification action provider documentation] for more details.
54
55
55
-
* The `TransferFile` state must be modified.
56
+
* The `TransferFile` **state** must be modified.
56
57
The `destination_endpoint` must be set to the destination Guest Collection ID that will receive approved files,
57
58
and the `destination_path` should match the target directory you want approved files transferred to.
58
59
59
60
=== Execution requirements
60
61
61
-
* After modifying the flow definition and creating the flow in the Globus Flows service,
62
+
* After modifying the **flow** definition and creating the **flow** in the Globus Flows service,
62
63
a destination collection administrator must give the flow client write permission on the collection.
63
64
+
64
-
This can be accomplished in the Web App, in the destination collection's Permissions tab,
65
-
by clicking the "Add Permissions" button and searching for the flow ID as the username to share with,
65
+
This can be accomplished in the Web App, in the destination **collection**'s Permissions tab,
66
+
by clicking the "Add Permissions" button and searching for the **flow** ID as the username to share with,
66
67
and ensuring that the "Write" checkbox is checked.
67
68
+
68
69
It's also possible to use the Globus CLI to accomplish this,
0 commit comments