@directus/app 9.20.3 → 9.21.0

package/dist/assets/{fields.7df6f624.js → fields.c76c2d8b.js}

@@ -1,4 +1,4 @@
-import{a,o as r,b as h,w as t,l as s,E as e,e as i}from"./runtime-core.esm-bundler.fe249c5c.js";const d={class:"markdown-body"},p=s("hr",null,null,-1),u=s("h2",{id:"the-field-object",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#the-field-object"},"#"),e(" The Field Object")],-1),_=s("p",null,[s("code",null,"collection"),e(),s("strong",null,"string"),s("br"),e(" Name of the collection the field resides in.")],-1),f=s("p",null,[s("code",null,"field"),e(),s("strong",null,"string"),s("br"),e(" The identifier of the field. This matches the table column name.")],-1),j=s("code",null,"type",-1),g=s("strong",null,"string",-1),m=s("br",null,null,-1),y=s("h4",{id:"meta",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#meta"},"#"),e(" Meta")],-1),b=s("p",null,"Directus metadata, primarily used in the Admin App. Meta is optional.",-1),x=s("p",null,[s("code",null,"id"),e(),s("strong",null,"integer"),s("br"),e(" Primary key of the metadata row in "),s("code",null,"directus_fields"),e(".")],-1),q=s("p",null,[s("code",null,"collection"),e(),s("strong",null,"string"),s("br"),e(" The name of the collection this field resides in.")],-1),T=s("p",null,[s("code",null,"field"),e(),s("strong",null,"string"),s("br"),e(" Identifier of the field. Matches the column name in the database.")],-1),w=s("p",null,[s("code",null,"special"),e(),s("strong",null,"string"),s("br"),e(" Any special transform flags that apply to this field.")],-1),k=s("p",null,[s("code",null,"interface"),e(),s("strong",null,"string"),s("br"),e(" The interface used for this field.")],-1),v=s("p",null,[s("code",null,"options"),e(),s("strong",null,"object"),s("br"),e(" The interface options configured for this field. The structure is based on the interface used.")],-1),A=s("p",null,[s("code",null,"display"),e(),s("strong",null,"string"),s("br"),e(" The display used for this field.")],-1),E=s("p",null,[s("code",null,"display_options"),e(),s("strong",null,"string"),s("br"),e(" The configured options for the used display.")],-1),S=s("p",null,[s("code",null,"readonly"),e(),s("strong",null,"boolean"),s("br"),e(" If the field is considered readonly in the Admin App.")],-1),P=s("p",null,[s("code",null,"hidden"),e(),s("strong",null,"boolean"),s("br"),e(" If the field is hidden from the edit page in the Admin App.")],-1),R=s("p",null,[s("code",null,"sort"),e(),s("strong",null,"integer"),s("br"),e(" Where this field is shown on the edit page in the Admin App.")],-1),Q=s("p",null,[s("code",null,"width"),e(),s("strong",null,"string"),s("br"),e(" How wide the interface is rendered on the edit page in the Admin App. One of "),s("code",null,"half"),e(", "),s("code",null,"half-left"),e(", "),s("code",null,"half-right"),e(", "),s("code",null,"half-space"),e(", "),s("code",null,"full"),e(", "),s("code",null,"fill"),e(".")],-1),I=s("p",null,[s("code",null,"translations"),e(),s("strong",null,"array"),s("br"),e(" How this field\u2019s name is displayed in the different languages in the Admin App.")],-1),L=s("p",null,[s("code",null,"note"),e(),s("strong",null,"string"),s("br"),e(" Short description displayed in the Admin App.")],-1),F=s("h4",{id:"schema",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#schema"},"#"),e(" Schema")],-1),G=s("p",null,"\u201CRaw\u201D database information. Based on the database vendor used, different information might be returned. The following are available for all drivers. Note: schema is optional. If a field exist in directus_fields, but not in the database, it\u2019s an alias commonly used for relational (O2M) or presentation purposes in the Admin App.",-1),C=s("p",null,[s("code",null,"name"),e(),s("strong",null,"string"),s("br"),e(" Identifier of the field. Matches the column name in the database.")],-1),O=s("p",null,[s("code",null,"table"),e(),s("strong",null,"string"),s("br"),e(" Name of the table the column resides in.")],-1),D=s("p",null,[s("code",null,"data_type"),e(),s("strong",null,"string"),s("br"),e(" The datatype as used in the database. Note: this value is database vendor specific.")],-1),H=s("p",null,[s("code",null,"default_value"),e(),s("strong",null,"any"),s("br"),e(" The configured default value for the column.")],-1),M=s("p",null,[s("code",null,"max_length"),e(),s("strong",null,"integer"),s("br"),e(" Configured length for varchar type columns.")],-1),B=s("p",null,[s("code",null,"numeric_precision"),e(),s("strong",null,"integer"),s("br"),e(" Precision for integer/float/decimal type fields.")],-1),N=s("p",null,[s("code",null,"numeric_scale"),e(),s("strong",null,"integer"),s("br"),e(" Scale for integer/float/decimal type fields.")],-1),W=s("p",null,[s("code",null,"is_nullable"),e(),s("strong",null,"boolean"),s("br"),e(" Whether or not the column is nullable. This is what is used as the \u201Crequired\u201D state in Directus.")],-1),U=s("p",null,[s("code",null,"is_primary_key"),e(),s("strong",null,"boolean"),s("br"),e(" Whether or not the field is the primary key of the table.")],-1),V=s("p",null,[s("code",null,"foreign_key_column"),e(),s("strong",null,"string"),s("br"),e(" If the current column has a foreign key constraint, this points to the related column.")],-1),z=s("p",null,[s("code",null,"foreign_key_table"),e(),s("strong",null,"string"),s("br"),e(" If the current column has a foreign key constraint, this points to the related table.")],-1),J=s("p",null,[s("code",null,"comment"),e(),s("strong",null,"string"),s("br"),e(" Comment as stored in the database.")],-1),K=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),e(`
+import{a,o as r,e as h,y as t,u as s,q as e,z as i}from"./runtime-core.esm-bundler.22ec0346.js";const d={class:"markdown-body"},p=s("hr",null,null,-1),u=s("h2",{id:"the-field-object",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#the-field-object"},"#"),e(" The Field Object")],-1),_=s("p",null,[s("code",null,"collection"),e(),s("strong",null,"string"),s("br"),e(" Name of the collection the field resides in.")],-1),f=s("p",null,[s("code",null,"field"),e(),s("strong",null,"string"),s("br"),e(" The identifier of the field. This matches the table column name.")],-1),j=s("code",null,"type",-1),g=s("strong",null,"string",-1),m=s("br",null,null,-1),y=s("h4",{id:"meta",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#meta"},"#"),e(" Meta")],-1),b=s("p",null,"Directus metadata, primarily used in the Admin App. Meta is optional.",-1),x=s("p",null,[s("code",null,"id"),e(),s("strong",null,"integer"),s("br"),e(" Primary key of the metadata row in "),s("code",null,"directus_fields"),e(".")],-1),q=s("p",null,[s("code",null,"collection"),e(),s("strong",null,"string"),s("br"),e(" The name of the collection this field resides in.")],-1),T=s("p",null,[s("code",null,"field"),e(),s("strong",null,"string"),s("br"),e(" Identifier of the field. Matches the column name in the database.")],-1),w=s("p",null,[s("code",null,"special"),e(),s("strong",null,"string"),s("br"),e(" Any special transform flags that apply to this field.")],-1),k=s("p",null,[s("code",null,"interface"),e(),s("strong",null,"string"),s("br"),e(" The interface used for this field.")],-1),v=s("p",null,[s("code",null,"options"),e(),s("strong",null,"object"),s("br"),e(" The interface options configured for this field. The structure is based on the interface used.")],-1),A=s("p",null,[s("code",null,"display"),e(),s("strong",null,"string"),s("br"),e(" The display used for this field.")],-1),E=s("p",null,[s("code",null,"display_options"),e(),s("strong",null,"string"),s("br"),e(" The configured options for the used display.")],-1),S=s("p",null,[s("code",null,"readonly"),e(),s("strong",null,"boolean"),s("br"),e(" If the field is considered readonly in the Admin App.")],-1),P=s("p",null,[s("code",null,"hidden"),e(),s("strong",null,"boolean"),s("br"),e(" If the field is hidden from the edit page in the Admin App.")],-1),R=s("p",null,[s("code",null,"sort"),e(),s("strong",null,"integer"),s("br"),e(" Where this field is shown on the edit page in the Admin App.")],-1),Q=s("p",null,[s("code",null,"width"),e(),s("strong",null,"string"),s("br"),e(" How wide the interface is rendered on the edit page in the Admin App. One of "),s("code",null,"half"),e(", "),s("code",null,"half-left"),e(", "),s("code",null,"half-right"),e(", "),s("code",null,"half-space"),e(", "),s("code",null,"full"),e(", "),s("code",null,"fill"),e(".")],-1),I=s("p",null,[s("code",null,"translations"),e(),s("strong",null,"array"),s("br"),e(" How this field\u2019s name is displayed in the different languages in the Admin App.")],-1),L=s("p",null,[s("code",null,"note"),e(),s("strong",null,"string"),s("br"),e(" Short description displayed in the Admin App.")],-1),F=s("h4",{id:"schema",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#schema"},"#"),e(" Schema")],-1),G=s("p",null,"\u201CRaw\u201D database information. Based on the database vendor used, different information might be returned. The following are available for all drivers. Note: schema is optional. If a field exist in directus_fields, but not in the database, it\u2019s an alias commonly used for relational (O2M) or presentation purposes in the Admin App.",-1),C=s("p",null,[s("code",null,"name"),e(),s("strong",null,"string"),s("br"),e(" Identifier of the field. Matches the column name in the database.")],-1),O=s("p",null,[s("code",null,"table"),e(),s("strong",null,"string"),s("br"),e(" Name of the table the column resides in.")],-1),D=s("p",null,[s("code",null,"data_type"),e(),s("strong",null,"string"),s("br"),e(" The datatype as used in the database. Note: this value is database vendor specific.")],-1),H=s("p",null,[s("code",null,"default_value"),e(),s("strong",null,"any"),s("br"),e(" The configured default value for the column.")],-1),M=s("p",null,[s("code",null,"max_length"),e(),s("strong",null,"integer"),s("br"),e(" Configured length for varchar type columns.")],-1),B=s("p",null,[s("code",null,"numeric_precision"),e(),s("strong",null,"integer"),s("br"),e(" Precision for integer/float/decimal type fields.")],-1),N=s("p",null,[s("code",null,"numeric_scale"),e(),s("strong",null,"integer"),s("br"),e(" Scale for integer/float/decimal type fields.")],-1),W=s("p",null,[s("code",null,"is_nullable"),e(),s("strong",null,"boolean"),s("br"),e(" Whether or not the column is nullable. This is what is used as the \u201Crequired\u201D state in Directus.")],-1),U=s("p",null,[s("code",null,"is_primary_key"),e(),s("strong",null,"boolean"),s("br"),e(" Whether or not the field is the primary key of the table.")],-1),V=s("p",null,[s("code",null,"foreign_key_column"),e(),s("strong",null,"string"),s("br"),e(" If the current column has a foreign key constraint, this points to the related column.")],-1),z=s("p",null,[s("code",null,"foreign_key_table"),e(),s("strong",null,"string"),s("br"),e(" If the current column has a foreign key constraint, this points to the related table.")],-1),J=s("p",null,[s("code",null,"comment"),e(),s("strong",null,"string"),s("br"),e(" Comment as stored in the database.")],-1),K=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),e(`
 	`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"articles"'),s("span",{class:"hljs-punctuation"},","),e(`
 	`),s("span",{class:"hljs-attr"},'"field"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"id"'),s("span",{class:"hljs-punctuation"},","),e(`
 	`),s("span",{class:"hljs-attr"},'"type"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"integer"'),s("span",{class:"hljs-punctuation"},","),e(`

package/dist/assets/{file-library.7a11d866.js → file-library.8fb3da43.js}

@@ -1 +1 @@
-import{a as n,o as d,b as c,w as t,l as e,E as l,e as o}from"./runtime-core.esm-bundler.fe249c5c.js";const h={class:"markdown-body"},u=e("blockquote",null,[e("p",null,"The File Library Module aggregates all files within the Directus Project into one consolidated library. It is a full-featured Digital Asset Management (DAM) system for storing, organizing, browsing, and transforming your various files and assets.")],-1),p=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/file-library-20220307A.webp",alt:"File Library"})],-1),f={class:"warning hint"},m=e("div",{class:"hint-title"},"More Documents on Folder and File Management",-1),g=e("h2",{id:"how-it-works",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#how-it-works"},"#"),l(" How it Works")],-1),_={class:"tip hint"},y=e("div",{class:"hint-title"},"Required Knowledge",-1),b=e("a",{href:"#folders"},"Folder",-1),F=e("a",{href:"#files"},"Files",-1),v=e("em",null,"not just images",-1),w=e("a",{href:"#folders"},"File Listing Page",-1),k=e("video",{title:"How the File Library Works",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/how-it-works-20220305A.mp4",type:"video/mp4"}),e("p",null,[l(" Your browser is not displaying the video for some reason. Here's a "),e("a",{href:""},"link to the video"),l(" instead. ")])],-1),A=e("ol",null,[e("li",null,[l("Select a Folder. There are two options: "),e("ul",null,[e("li",null,"Choose desired Folder from the Navigation Bar."),e("li",null,[l("Click "),e("span",{mi:"",btn:"",sec:""},"create_new_folder"),l(" in the Page Header, name your folder, and click "),e("strong",null,"\u201CSave\u201D"),l(".")])])]),e("li",null,[l("Click "),e("span",{mi:"",btn:""},"add"),l(" in the Page Header. A popover will appear.")]),e("li",null,[l("Upload your file. You have 3 options: "),e("ul",null,[e("li",null,"Drag a file from your desktop to the popup."),e("li",null,"Click the popup area to manually select a file from your device."),e("li",null,[l("Click "),e("span",{mi:"",icon:""},"more_vert"),l(" in the popover and choose "),e("strong",null,"\u201CImport from URL\u201D"),l(".")])])]),e("li",null,"Optional: Click the File Display to open the File Details Page and fill in information as desired.")],-1),C=e("h2",{id:"files",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#files"},"#"),l(" Files")],-1),T=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/files-20220305A.webp",alt:"Files"})],-1),D=e("h3",{id:"action-buttons",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#action-buttons"},"#"),l(" Action Buttons")],-1),L=e("p",null,"Notice the following Buttons in the Header:",-1),P=e("ul",null,[e("li",null,[e("span",{mi:"",btn:""},"check"),l(" \u2013 Saves any edits made to the file.")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"tune"),l(" \u2013 Please see "),e("a",{href:"#edit-an-image"},"Edit an Image"),l(" to learn more.")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"save_alt"),l(" \u2013 Downloads the file to your current device.")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"drive_file_move"),l(" \u2013 Moves selected File(s) to another Folder.")]),e("li",null,[e("span",{mi:"",btn:"",dngr:""},"delete"),l(" \u2013 Permanently removes the File and its metadata. This action is permanent and cannot be undone.")])],-1),I=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Deleting Files Linked to Items"),e("p",null,[l("By default, Directus will not allow you to delete a File until you remove it from any and all related Items. However, this behavior can be reconfigured so that Files automatically update when the image is deleted by setting the relational constraint of your File Field to "),e("code",null,"SET NULL"),l(" or "),e("code",null,"CASCADE"),l(" when the File is deleted.")])],-1),x=e("h3",{id:"file-details",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#file-details"},"#"),l(" File Details")],-1),M=e("p",null,[l("The Files Collection comes pre-configured with the following Fields out of the box. New Fields can be created and customized as needed in "),e("strong",null,"Settings > Data Model"),l(". However the pre-configured Fields cannot be changed or deleted.")],-1),S=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/file-details-20220305A.webp",alt:"File Details"})],-1),E=e("ul",null,[e("li",null,[e("strong",null,"Preview"),l(" \u2013 A preview of the image or file.")]),e("li",null,[e("strong",null,"Title"),l(" \u2013 A title for the File.")]),e("li",null,[e("strong",null,"Description"),l(" \u2013 A description of the File.")]),e("li",null,[e("strong",null,"Tags"),l(" \u2013 Keywords used for search-ability.")]),e("li",null,[e("strong",null,"Location"),l(" \u2013 An optional location "),e("em",null,"(e.g. where a photo was taken)"),l(".")]),e("li",null,[e("strong",null,"Storage"),l(" \u2013 Which storage adapter is used to store the file asset.")]),e("li",null,[e("strong",null,"Filename (Disk)"),l(" \u2013 LOCKED. This is the actual name of the file in storage.")]),e("li",null,[e("strong",null,"Filename (Download)"),l(" \u2013 Allows you to set the name of the file when it is downloaded.")])],-1),U=e("h3",{id:"file-sidebar",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#file-sidebar"},"#"),l(" File Sidebar")],-1),H=e("p",null,"The file sidebar also includes the following details, which are not editable and serve as metadata.",-1),B=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/file-sidebar-20220305A.webp",alt:"File Sidebar"})],-1),N=e("ul",null,[e("li",null,[e("strong",null,"Type"),l(" \u2013 The MIME type of the file, displayed in the App as a formatted media type.")]),e("li",null,[e("strong",null,"Dimensions"),l(" \u2013 "),e("em",null,"Images only"),l(". The width and height of the image in pixels.")]),e("li",null,[e("strong",null,"Size"),l(" \u2013 The file-size the asset takes up in the storage adapter.")]),e("li",null,[e("strong",null,"Created"),l(" \u2013 The timestamp of when the file was uploaded to the Project.")]),e("li",null,[e("strong",null,"Owner"),l(" \u2013 The User that uploaded the file to the Project.")]),e("li",null,[e("strong",null,"Modified"),l(" \u2013 The timestamp of when the file was last modified.")]),e("li",null,[e("strong",null,"Edited By"),l(" \u2013 The User that modified the File.")]),e("li",null,[e("strong",null,"Folder"),l(" \u2013 The current parent folder that contains the File.")]),e("li",null,[e("strong",null,"Metadata"),l(" \u2013 Metadata JSON dump of the File\u2019s EXIF, IPTC, and ICC information.")])],-1),R=e("h2",{id:"edit-an-image",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#edit-an-image"},"#"),l(" Edit an Image")],-1),W=e("p",null,"Rotate, crop, flip, or adjust aspect ratios of an image.",-1),j=e("video",{alt:"Edit an Image",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220516A/edit-an-image-20220516A.mp4",type:"video/mp4"})],-1),z=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", click a file to open its detail page.")]),e("li",null,[l("Click the "),e("span",{mi:"",btn:"",sec:""},"tune"),l(" button in the top right to open the image editor.")]),e("li",null,[l("Make your changes and click "),e("span",{mi:"",btn:""},"check"),l(" in the top right to save the updates.")])],-1),O=e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Irreversible Change"),e("p",null,"Edits overwrite the original file on disk. This can\u2019t be reversed.")],-1),K=e("h2",{id:"upload-a-file",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#upload-a-file"},"#"),l(" Upload a File")],-1),V=e("a",{href:"#how-it-works"},"How it Works",-1),Y=e("h2",{id:"replace-a-file",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#replace-a-file"},"#"),l(" Replace a File")],-1),q=e("p",null,"When a file is replaced, its existing info and all relationships are kept.",-1),J=e("video",{alt:"Replace a File",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220608A/replace-a-file-20220608A.mp4",type:"video/mp4"})],-1),X=e("ol",null,[e("li",null,"Click the Image Preview on the File Detail page. A popup will appear."),e("li",null,[l("Upload your file. You have 3 options: "),e("ul",null,[e("li",null,"Drag a file from your desktop to the popup."),e("li",null,"Click the popup area to manually select a file from your device."),e("li",null,[l("Click "),e("span",{mi:"",icon:""},"more_vert"),l(" in the popover and choose "),e("strong",null,"\u201CImport from URL\u201D"),l(".")])])])],-1),G=e("h2",{id:"folders",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#folders"},"#"),l(" Folders")],-1),Q=e("p",null,"Folders provide the organization system for Files.",-1),Z=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/folders-20220305A.webp",alt:"Folders"})],-1),$=e("h2",{id:"create-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#create-a-folder"},"#"),l(" Create a Folder")],-1),ee=e("video",{alt:"Create a Folder",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/create-a-folder-20220305A.mp4",type:"video/mp4"})],-1),le=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", click on the "),e("span",{mi:"",btn:"",sec:""},"create_new_folder"),l(" button located in the Header.")]),e("li",null,"Fill in a Folder name as desired."),e("li",null,[l("Click "),e("strong",null,"\u201CSave\u201D"),l(".")])],-1),te=e("h2",{id:"rename-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#rename-a-folder"},"#"),l(" Rename a Folder")],-1),ie=e("video",{alt:"Renaming a Folder",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/rename-a-folder-20220215A.mp4",type:"video/mp4"})],-1),oe=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", right-click on the Folder you wish to rename and select \u201CRename Folder\u201D.")]),e("li",null,"Update the Folder name as desired."),e("li",null,[l("Click "),e("strong",null,"\u201CSave\u201D"),l(".")])],-1),ae=e("h2",{id:"move-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#move-a-folder"},"#"),l(" Move a Folder")],-1),ne=e("video",{alt:"Moving a Folder",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/move-a-folder20220305A.mp4",type:"video/mp4"})],-1),se=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", right-click on the folder you wish to move and select "),e("strong",null,"\u201CMove to Folder\u201D"),l(". A popup will appear.")]),e("li",null,"Select a Folder to serve as the new Parent Folder."),e("li",null,[l("Click "),e("strong",null,"\u201CSave\u201D"),l(".")])],-1),re=e("h2",{id:"delete-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#delete-a-folder"},"#"),l(" Delete a Folder")],-1),de=e("video",{alt:"Deleting a Folder",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/delete-a-folder-20220215A.mp4",type:"video/mp4"})],-1),ce=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", right-click on the Folder you wish to delete and select "),e("strong",null,"\u201CDelete Folder\u201D"),l(".")]),e("li",null,[l("Click "),e("strong",null,"\u201CDelete\u201D"),l(".")])],-1),he=e("div",{class:"tip hint"},[e("p",null,"When you delete a Folder, any nested Files and Folders will be moved one level up.")],-1),ue=e("h2",{id:"more-help",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#more-help"},"#"),l(" More Help")],-1),pe=e("p",null,[l("Looking for technical support for your non-enterprise project? Chat with thousands of engineers within our growing "),e("a",{href:"https://discord.com/invite/directus",target:"_blank",rel:"noopener noreferrer"},"Community on Discord")],-1),ye="File Library",be=!1,Fe="The File Library Module aggregates all files within the Directus Project into one consolidated library.",ve="7 min read",we={__name:"file-library",setup(fe,{expose:s}){const a={title:"File Library",modularExtension:!1,description:"The File Library Module aggregates all files within the Directus Project into one consolidated library.",readTime:"7 min read"};return s({frontmatter:a}),(me,ge)=>{const i=n("router-link"),r=n("docs-wrapper");return d(),c(r,{frontmatter:a},{default:t(()=>[e("div",h,[u,p,e("div",f,[m,e("p",null,[l("This is a non-technical, no-code guide to the File Library Module. Please note there is documentation on programmatic "),o(i,{to:"/docs/reference/system/folders"},{default:t(()=>[l("Folder")]),_:1}),l(" and "),o(i,{to:"/docs/reference/files"},{default:t(()=>[l("File")]),_:1}),l(" management via the API.")])]),g,e("div",_,[y,e("p",null,[l("Familiarity with the "),o(i,{to:"/docs/app/content/collections"},{default:t(()=>[l("Collections Page")]),_:1}),l(" will be helpful but not necessary.")])]),e("p",null,[l("The File Library acts as one big "),b,l(" to store all uploaded "),F,l(". Sub-folders can be created within the File Library to help Files stay organized. Folders and File information are stored in regular Collections, which means "),o(i,{to:"/docs/configuration/users-roles-permissions.md"},{default:t(()=>[l("User and Role access permissions")]),_:1}),l(" are fully configurable and granular on both Folders and Files. Multiple files can be uploaded at once through the app and also programmatically via the API. Any type of file can be uploaded, "),v,l(". When a Folder is selected from the Navigation Bar, the "),w,l(" is presented. This page has all the same features and functionalities as the "),o(i,{to:"/docs/app/content/collections"},{default:t(()=>[l("Collections Page")]),_:1}),l(".")]),k,A,C,e("p",null,[l("When a file is clicked in the File Listing Page, the File Details Page appears. This is a custom form for viewing assets and embeds, with core Fields included out-of-the-box (see below), and the ability for Administrators to add additional custom Fields. This page has the same features and functionality as the "),o(i,{to:"/docs/getting-started/glossary#items"},{default:t(()=>[l("Item Page")]),_:1}),l(".")]),T,D,L,P,I,x,M,S,E,U,H,B,N,R,W,j,z,O,K,e("p",null,[l("We covered the File Library\u2019s three upload methods in "),V,l(". Keep in mind that files can also be added through different Interfaces as well. For example, Users can upload an Avatar image when they fill in their User Details. Similarly, Items with an Image Field will have a file upload Interface on the Item Detail page. Files can also be "),o(i,{to:"/docs/reference/files"},{default:t(()=>[l("uploaded programmatically via the API")]),_:1}),l(".")]),Y,q,J,X,G,Q,Z,e("p",null,[l("They can be named, renamed, and nested as sub-folders anywhere in the Folder hierarchy. Once a Folder is selected from the Navigation Bar, File Listing Page opens. The File Listing Page displays all Files within a Folder. It also enables all other features and functionalities from the "),o(i,{to:"/docs/app/content/collections"},{default:t(()=>[l("Collections Page")]),_:1}),l(" such as batch editing, batch deleting, sorting, filtering, searching, etc. Folders can also be managed "),o(i,{to:"/docs/reference/system/folders"},{default:t(()=>[l("programmatically via the API")]),_:1}),l(".")]),$,ee,le,te,ie,oe,ae,ne,se,re,de,ce,he,ue,pe])]),_:1})}}};export{we as default,Fe as description,be as modularExtension,ve as readTime,ye as title};
+import{a as n,o as d,e as c,y as t,u as e,q as l,z as o}from"./runtime-core.esm-bundler.22ec0346.js";const h={class:"markdown-body"},u=e("blockquote",null,[e("p",null,"The File Library Module aggregates all files within the Directus Project into one consolidated library. It is a full-featured Digital Asset Management (DAM) system for storing, organizing, browsing, and transforming your various files and assets.")],-1),p=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/file-library-20220307A.webp",alt:"File Library"})],-1),f={class:"warning hint"},m=e("div",{class:"hint-title"},"More Documents on Folder and File Management",-1),g=e("h2",{id:"how-it-works",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#how-it-works"},"#"),l(" How it Works")],-1),_={class:"tip hint"},y=e("div",{class:"hint-title"},"Required Knowledge",-1),b=e("a",{href:"#folders"},"Folder",-1),F=e("a",{href:"#files"},"Files",-1),v=e("em",null,"not just images",-1),w=e("a",{href:"#folders"},"File Listing Page",-1),k=e("video",{title:"How the File Library Works",autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/how-it-works-20220305A.mp4",type:"video/mp4"}),e("p",null,[l(" Your browser is not displaying the video for some reason. Here's a "),e("a",{href:""},"link to the video"),l(" instead. ")])],-1),A=e("ol",null,[e("li",null,[l("Select a Folder. There are two options: "),e("ul",null,[e("li",null,"Choose desired Folder from the Navigation Bar."),e("li",null,[l("Click "),e("span",{mi:"",btn:"",sec:""},"create_new_folder"),l(" in the Page Header, name your folder, and click "),e("strong",null,"\u201CSave\u201D"),l(".")])])]),e("li",null,[l("Click "),e("span",{mi:"",btn:""},"add"),l(" in the Page Header. A popover will appear.")]),e("li",null,[l("Upload your file. You have 3 options: "),e("ul",null,[e("li",null,"Drag a file from your desktop to the popup."),e("li",null,"Click the popup area to manually select a file from your device."),e("li",null,[l("Click "),e("span",{mi:"",icon:""},"more_vert"),l(" in the popover and choose "),e("strong",null,"\u201CImport from URL\u201D"),l(".")])])]),e("li",null,"Optional: Click the File Display to open the File Details Page and fill in information as desired.")],-1),C=e("h2",{id:"files",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#files"},"#"),l(" Files")],-1),T=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/files-20220305A.webp",alt:"Files"})],-1),D=e("h3",{id:"action-buttons",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#action-buttons"},"#"),l(" Action Buttons")],-1),L=e("p",null,"Notice the following Buttons in the Header:",-1),P=e("ul",null,[e("li",null,[e("span",{mi:"",btn:""},"check"),l(" \u2013 Saves any edits made to the file.")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"tune"),l(" \u2013 Please see "),e("a",{href:"#edit-an-image"},"Edit an Image"),l(" to learn more.")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"save_alt"),l(" \u2013 Downloads the file to your current device.")]),e("li",null,[e("span",{mi:"",btn:"",sec:""},"drive_file_move"),l(" \u2013 Moves selected File(s) to another Folder.")]),e("li",null,[e("span",{mi:"",btn:"",dngr:""},"delete"),l(" \u2013 Permanently removes the File and its metadata. This action is permanent and cannot be undone.")])],-1),I=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Deleting Files Linked to Items"),e("p",null,[l("By default, Directus will not allow you to delete a File until you remove it from any and all related Items. However, this behavior can be reconfigured so that Files automatically update when the image is deleted by setting the relational constraint of your File Field to "),e("code",null,"SET NULL"),l(" or "),e("code",null,"CASCADE"),l(" when the File is deleted.")])],-1),x=e("h3",{id:"file-details",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#file-details"},"#"),l(" File Details")],-1),M=e("p",null,[l("The Files Collection comes pre-configured with the following Fields out of the box. New Fields can be created and customized as needed in "),e("strong",null,"Settings > Data Model"),l(". However the pre-configured Fields cannot be changed or deleted.")],-1),S=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/file-details-20220305A.webp",alt:"File Details"})],-1),E=e("ul",null,[e("li",null,[e("strong",null,"Preview"),l(" \u2013 A preview of the image or file.")]),e("li",null,[e("strong",null,"Title"),l(" \u2013 A title for the File.")]),e("li",null,[e("strong",null,"Description"),l(" \u2013 A description of the File.")]),e("li",null,[e("strong",null,"Tags"),l(" \u2013 Keywords used for search-ability.")]),e("li",null,[e("strong",null,"Location"),l(" \u2013 An optional location "),e("em",null,"(e.g. where a photo was taken)"),l(".")]),e("li",null,[e("strong",null,"Storage"),l(" \u2013 Which storage adapter is used to store the file asset.")]),e("li",null,[e("strong",null,"Filename (Disk)"),l(" \u2013 LOCKED. This is the actual name of the file in storage.")]),e("li",null,[e("strong",null,"Filename (Download)"),l(" \u2013 Allows you to set the name of the file when it is downloaded.")])],-1),U=e("h3",{id:"file-sidebar",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#file-sidebar"},"#"),l(" File Sidebar")],-1),H=e("p",null,"The file sidebar also includes the following details, which are not editable and serve as metadata.",-1),B=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/file-sidebar-20220305A.webp",alt:"File Sidebar"})],-1),N=e("ul",null,[e("li",null,[e("strong",null,"Type"),l(" \u2013 The MIME type of the file, displayed in the App as a formatted media type.")]),e("li",null,[e("strong",null,"Dimensions"),l(" \u2013 "),e("em",null,"Images only"),l(". The width and height of the image in pixels.")]),e("li",null,[e("strong",null,"Size"),l(" \u2013 The file-size the asset takes up in the storage adapter.")]),e("li",null,[e("strong",null,"Created"),l(" \u2013 The timestamp of when the file was uploaded to the Project.")]),e("li",null,[e("strong",null,"Owner"),l(" \u2013 The User that uploaded the file to the Project.")]),e("li",null,[e("strong",null,"Modified"),l(" \u2013 The timestamp of when the file was last modified.")]),e("li",null,[e("strong",null,"Edited By"),l(" \u2013 The User that modified the File.")]),e("li",null,[e("strong",null,"Folder"),l(" \u2013 The current parent folder that contains the File.")]),e("li",null,[e("strong",null,"Metadata"),l(" \u2013 Metadata JSON dump of the File\u2019s EXIF, IPTC, and ICC information.")])],-1),R=e("h2",{id:"edit-an-image",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#edit-an-image"},"#"),l(" Edit an Image")],-1),W=e("p",null,"Rotate, crop, flip, or adjust aspect ratios of an image.",-1),j=e("video",{alt:"Edit an Image",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220516A/edit-an-image-20220516A.mp4",type:"video/mp4"})],-1),z=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", click a file to open its detail page.")]),e("li",null,[l("Click the "),e("span",{mi:"",btn:"",sec:""},"tune"),l(" button in the top right to open the image editor.")]),e("li",null,[l("Make your changes and click "),e("span",{mi:"",btn:""},"check"),l(" in the top right to save the updates.")])],-1),O=e("div",{class:"danger hint"},[e("div",{class:"hint-title"},"Irreversible Change"),e("p",null,"Edits overwrite the original file on disk. This can\u2019t be reversed.")],-1),K=e("h2",{id:"upload-a-file",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#upload-a-file"},"#"),l(" Upload a File")],-1),q=e("a",{href:"#how-it-works"},"How it Works",-1),V=e("h2",{id:"replace-a-file",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#replace-a-file"},"#"),l(" Replace a File")],-1),Y=e("p",null,"When a file is replaced, its existing info and all relationships are kept.",-1),J=e("video",{alt:"Replace a File",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220608A/replace-a-file-20220608A.mp4",type:"video/mp4"})],-1),X=e("ol",null,[e("li",null,"Click the Image Preview on the File Detail page. A popup will appear."),e("li",null,[l("Upload your file. You have 3 options: "),e("ul",null,[e("li",null,"Drag a file from your desktop to the popup."),e("li",null,"Click the popup area to manually select a file from your device."),e("li",null,[l("Click "),e("span",{mi:"",icon:""},"more_vert"),l(" in the popover and choose "),e("strong",null,"\u201CImport from URL\u201D"),l(".")])])])],-1),G=e("h2",{id:"folders",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#folders"},"#"),l(" Folders")],-1),Q=e("p",null,"Folders provide the organization system for Files.",-1),Z=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/folders-20220305A.webp",alt:"Folders"})],-1),$=e("h2",{id:"create-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#create-a-folder"},"#"),l(" Create a Folder")],-1),ee=e("video",{alt:"Create a Folder",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/create-a-folder-20220305A.mp4",type:"video/mp4"})],-1),le=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", click on the "),e("span",{mi:"",btn:"",sec:""},"create_new_folder"),l(" button located in the Header.")]),e("li",null,"Fill in a Folder name as desired."),e("li",null,[l("Click "),e("strong",null,"\u201CSave\u201D"),l(".")])],-1),te=e("h2",{id:"rename-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#rename-a-folder"},"#"),l(" Rename a Folder")],-1),ie=e("video",{alt:"Renaming a Folder",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/rename-a-folder-20220215A.mp4",type:"video/mp4"})],-1),oe=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", right-click on the Folder you wish to rename and select \u201CRename Folder\u201D.")]),e("li",null,"Update the Folder name as desired."),e("li",null,[l("Click "),e("strong",null,"\u201CSave\u201D"),l(".")])],-1),ae=e("h2",{id:"move-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#move-a-folder"},"#"),l(" Move a Folder")],-1),ne=e("video",{alt:"Moving a Folder",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/file-library-20220305A/move-a-folder20220305A.mp4",type:"video/mp4"})],-1),se=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", right-click on the folder you wish to move and select "),e("strong",null,"\u201CMove to Folder\u201D"),l(". A popup will appear.")]),e("li",null,"Select a Folder to serve as the new Parent Folder."),e("li",null,[l("Click "),e("strong",null,"\u201CSave\u201D"),l(".")])],-1),re=e("h2",{id:"delete-a-folder",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#delete-a-folder"},"#"),l(" Delete a Folder")],-1),de=e("video",{alt:"Deleting a Folder",loop:"",muted:"",controls:"",autoplay:"",playsinline:""},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/file-library/delete-a-folder-20220215A.mp4",type:"video/mp4"})],-1),ce=e("ol",null,[e("li",null,[l("From the "),e("strong",null,"File Library"),l(", right-click on the Folder you wish to delete and select "),e("strong",null,"\u201CDelete Folder\u201D"),l(".")]),e("li",null,[l("Click "),e("strong",null,"\u201CDelete\u201D"),l(".")])],-1),he=e("div",{class:"tip hint"},[e("p",null,"When you delete a Folder, any nested Files and Folders will be moved one level up.")],-1),ue=e("h2",{id:"more-help",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#more-help"},"#"),l(" More Help")],-1),pe=e("p",null,[l("Looking for technical support for your non-enterprise project? Chat with thousands of engineers within our growing "),e("a",{href:"https://discord.com/invite/directus",target:"_blank",rel:"noopener noreferrer"},"Community on Discord")],-1),ye="File Library",be=!1,Fe="The File Library Module aggregates all files within the Directus Project into one consolidated library.",ve="7 min read",we={__name:"file-library",setup(fe,{expose:s}){const a={title:"File Library",modularExtension:!1,description:"The File Library Module aggregates all files within the Directus Project into one consolidated library.",readTime:"7 min read"};return s({frontmatter:a}),(me,ge)=>{const i=n("router-link"),r=n("docs-wrapper");return d(),c(r,{frontmatter:a},{default:t(()=>[e("div",h,[u,p,e("div",f,[m,e("p",null,[l("This is a non-technical, no-code guide to the File Library Module. Please note there is documentation on programmatic "),o(i,{to:"/docs/reference/system/folders"},{default:t(()=>[l("Folder")]),_:1}),l(" and "),o(i,{to:"/docs/reference/files"},{default:t(()=>[l("File")]),_:1}),l(" management via the API.")])]),g,e("div",_,[y,e("p",null,[l("Familiarity with the "),o(i,{to:"/docs/app/content/collections"},{default:t(()=>[l("Collections Page")]),_:1}),l(" will be helpful but not necessary.")])]),e("p",null,[l("The File Library acts as one big "),b,l(" to store all uploaded "),F,l(". Sub-folders can be created within the File Library to help Files stay organized. Folders and File information are stored in regular Collections, which means "),o(i,{to:"/docs/configuration/users-roles-permissions.md"},{default:t(()=>[l("User and Role access permissions")]),_:1}),l(" are fully configurable and granular on both Folders and Files. Multiple files can be uploaded at once through the app and also programmatically via the API. Any type of file can be uploaded, "),v,l(". When a Folder is selected from the Navigation Bar, the "),w,l(" is presented. This page has all the same features and functionalities as the "),o(i,{to:"/docs/app/content/collections"},{default:t(()=>[l("Collections Page")]),_:1}),l(".")]),k,A,C,e("p",null,[l("When a file is clicked in the File Listing Page, the File Details Page appears. This is a custom form for viewing assets and embeds, with core Fields included out-of-the-box (see below), and the ability for Administrators to add additional custom Fields. This page has the same features and functionality as the "),o(i,{to:"/docs/getting-started/glossary#items"},{default:t(()=>[l("Item Page")]),_:1}),l(".")]),T,D,L,P,I,x,M,S,E,U,H,B,N,R,W,j,z,O,K,e("p",null,[l("We covered the File Library\u2019s three upload methods in "),q,l(". Keep in mind that files can also be added through different Interfaces as well. For example, Users can upload an Avatar image when they fill in their User Details. Similarly, Items with an Image Field will have a file upload Interface on the Item Detail page. Files can also be "),o(i,{to:"/docs/reference/files"},{default:t(()=>[l("uploaded programmatically via the API")]),_:1}),l(".")]),V,Y,J,X,G,Q,Z,e("p",null,[l("They can be named, renamed, and nested as sub-folders anywhere in the Folder hierarchy. Once a Folder is selected from the Navigation Bar, File Listing Page opens. The File Listing Page displays all Files within a Folder. It also enables all other features and functionalities from the "),o(i,{to:"/docs/app/content/collections"},{default:t(()=>[l("Collections Page")]),_:1}),l(" such as batch editing, batch deleting, sorting, filtering, searching, etc. Folders can also be managed "),o(i,{to:"/docs/reference/system/folders"},{default:t(()=>[l("programmatically via the API")]),_:1}),l(".")]),$,ee,le,te,ie,oe,ae,ne,se,re,de,ce,he,ue,pe])]),_:1})}}};export{we as default,Fe as description,be as modularExtension,ve as readTime,ye as title};

package/dist/assets/{files.84b41f2f.js → files.d8e3acf4.js}

@@ -1,4 +1,4 @@
-import{a as o,o as c,b as h,w as a,l as s,E as e,e as n}from"./runtime-core.esm-bundler.fe249c5c.js";const d={class:"markdown-body"},u=s("blockquote",null,[s("p",null,[e("Every file managed by the platform is uploaded to the configured storage adapter, and its associated metadata is tracked within the "),s("code",null,"directus_files"),e(" system collection. Any requested file transformations are handled on the fly, and are only saved to storage.")])],-1),p=s("hr",null,null,-1),_=s("h2",{id:"accessing-a-file",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#accessing-a-file"},"#"),e(" Accessing a File")],-1),f=s("p",null,"The location of your actual file originals is based on the project\u2019s configuration, but you can consistently access them via the API using the following URL.",-1),m=s("pre",null,[s("code",{class:"language-txt"},`example.com/assets/<file-id>
+import{a as o,o as c,e as h,y as a,u as s,q as e,z as n}from"./runtime-core.esm-bundler.22ec0346.js";const d={class:"markdown-body"},u=s("blockquote",null,[s("p",null,[e("Every file managed by the platform is uploaded to the configured storage adapter, and its associated metadata is tracked within the "),s("code",null,"directus_files"),e(" system collection. Any requested file transformations are handled on the fly, and are only saved to storage.")])],-1),p=s("hr",null,null,-1),_=s("h2",{id:"accessing-a-file",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#accessing-a-file"},"#"),e(" Accessing a File")],-1),f=s("p",null,"The location of your actual file originals is based on the project\u2019s configuration, but you can consistently access them via the API using the following URL.",-1),m=s("pre",null,[s("code",{class:"language-txt"},`example.com/assets/<file-id>
 example.com/assets/1ac73658-8b62-4dea-b6da-529fbc9d01a4
 `)],-1),g=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"SEO"),s("p",null,"You can provide an optional filename after the UUID to optimize for SEO, for example:"),s("pre",null,[s("code",{class:"language-txt"},`example.com/assets/<file-id>/<filename>
 example.com/assets/1ac73658-8b62-4dea-b6da-529fbc9d01a4/directus-logo.png
@@ -69,7 +69,7 @@ SEARCH /files
 		filename_disk
 	}
 }
-`)])],-1),Ns=s("h2",{id:"upload-a-file",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#upload-a-file"},"#"),e(" Upload a File")],-1),Zs=s("p",null,"Upload/create a new file.",-1),Hs=s("p",null,[e("To upload a file, use "),s("code",null,"multipart/form-data"),e(" as the encoding type, instead of JSON.")],-1),Ws=s("p",null,[e("The file contents has to be provided in a part called "),s("code",null,"file"),e(". All other properties of "),s("a",{href:"#the-file-object"},"the file object"),e(" can be provided as parts as well, except "),s("code",null,"filename_disk"),e(" and "),s("code",null,"filename_download"),e(".")],-1),Ks=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Order Matters"),s("p",null,[e("Make sure to define the non-file properties "),s("em",null,"first"),e(". This ensures that the file metadata is associated with the correct file.")])],-1),Js=s("p",null,"You can upload multiple files at a time by repeating the payload with different contents, for example:",-1),Vs=s("pre",null,[s("code",null,`--__X_BOUNDARY__
+`)])],-1),Ns=s("h2",{id:"upload-a-file",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#upload-a-file"},"#"),e(" Upload a File")],-1),Zs=s("p",null,"Upload/create a new file.",-1),Hs=s("p",null,[e("To upload a file, use "),s("code",null,"multipart/form-data"),e(" as the encoding type. The file contents has to be provided in a part called "),s("code",null,"file"),e(". All other properties of "),s("a",{href:"#the-file-object"},"the file object"),e(" can be provided as parts as well, except "),s("code",null,"filename_disk"),e(" and "),s("code",null,"filename_download"),e(".")],-1),Ws=s("p",null,[e("Alternatively, you can use "),s("code",null,"application/json"),e(" with JSON request body to associate metadata to a file that already exists in the storage. The "),s("code",null,"type"),e(" property will be required to specify the mimetype of that file.")],-1),Ks=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Order Matters"),s("p",null,[e("Make sure to define the non-file properties "),s("em",null,"first"),e(". This ensures that the file metadata is associated with the correct file.")])],-1),Js=s("p",null,"You can upload multiple files at a time by repeating the payload with different contents, for example:",-1),Vs=s("pre",null,[s("code",null,`--__X_BOUNDARY__
 Content-Disposition: form-data; name="title"
 
 Example

package/dist/assets/{filter-rules.099e9689.js → filter-rules.edb18765.js}

@@ -1,4 +1,4 @@
-import{a as l,o as c,b as i,w as a,l as t,E as n,e as r}from"./runtime-core.esm-bundler.fe249c5c.js";const p={class:"markdown-body"},h=t("blockquote",null,[t("p",null,[n("Permissions, validation, and the API\u2019s "),t("code",null,"filter"),n(" parameter all rely on a specific JSON structure to define their rules. This page describes the syntax for creating flat, relational, or complex filter rules.")])],-1),d=t("h2",{id:"syntax",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#syntax"},"#"),n(" Syntax")],-1),j=t("ul",null,[t("li",null,[t("strong",null,"Field"),n(" \u2014 Any valid root field, "),t("a",{href:"#relational"},"relational field"),n(", or "),t("a",{href:"#logical-operators"},"logical operator")]),t("li",null,[t("strong",null,"Operator"),n(" \u2014 Any valid "),t("a",{href:"#filter-operators"},"filter operator")]),t("li",null,[t("strong",null,"Value"),n(" \u2014 Any valid static value, or "),t("a",{href:"#dynamic-variables"},"dynamic variable")])],-1),_=t("pre",null,[t("code",null,`{
+import{a as l,o as c,e as i,y as a,u as t,q as n,z as r}from"./runtime-core.esm-bundler.22ec0346.js";const p={class:"markdown-body"},h=t("blockquote",null,[t("p",null,[n("Permissions, validation, and the API\u2019s "),t("code",null,"filter"),n(" parameter all rely on a specific JSON structure to define their rules. This page describes the syntax for creating flat, relational, or complex filter rules.")])],-1),d=t("h2",{id:"syntax",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#syntax"},"#"),n(" Syntax")],-1),j=t("ul",null,[t("li",null,[t("strong",null,"Field"),n(" \u2014 Any valid root field, "),t("a",{href:"#relational"},"relational field"),n(", or "),t("a",{href:"#logical-operators"},"logical operator")]),t("li",null,[t("strong",null,"Operator"),n(" \u2014 Any valid "),t("a",{href:"#filter-operators"},"filter operator")]),t("li",null,[t("strong",null,"Value"),n(" \u2014 Any valid static value, or "),t("a",{href:"#dynamic-variables"},"dynamic variable")])],-1),_=t("pre",null,[t("code",null,`{
 	<field>: {
 		<operator>: <value>
 	}
@@ -25,7 +25,7 @@ import{a as l,o as c,b as i,w as a,l as t,E as n,e as r}from"./runtime-core.esm-
 		`),t("span",{class:"hljs-punctuation"},"}"),n(`
 	`),t("span",{class:"hljs-punctuation"},"}"),n(`
 `),t("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),N=t("p",null,[n("When using M2M relationships, a junction table will be created and the filter applies to the junction table itself. For example, if you have a "),t("code",null,"books"),n(" collection, with a M2M relationship to authors of each book, the junction collection will probably be named "),t("code",null,"books_authors"),n(" and have 3 fields : "),t("code",null,"id"),n(", "),t("code",null,"books_id"),n(" and "),t("code",null,"authors_id"),n(". To filter specific books depending on their authors you must go through the junction table and the "),t("code",null,"authors_id"),n(" field :")],-1),O=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),n(`
+`)])],-1),N=t("p",null,[n("When using M2M relationships, a junction table will be created and the filter applies to the junction table itself. For example, if you have a "),t("code",null,"books"),n(" collection, with a M2M relationship to authors of each book, the junction collection will probably be named "),t("code",null,"books_authors"),n(" and have 3 fields : "),t("code",null,"id"),n(", "),t("code",null,"books_id"),n(" and "),t("code",null,"authors_id"),n(". To filter specific books depending on their authors you must go through the junction table and the "),t("code",null,"authors_id"),n(" field :")],-1),q=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),n(`
 	`),t("span",{class:"hljs-attr"},'"authors"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
 		`),t("span",{class:"hljs-attr"},'"authors_id"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
 			`),t("span",{class:"hljs-attr"},'"name"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
@@ -34,7 +34,7 @@ import{a as l,o as c,b as i,w as a,l as t,E as n,e as r}from"./runtime-core.esm-
 		`),t("span",{class:"hljs-punctuation"},"}"),n(`
 	`),t("span",{class:"hljs-punctuation"},"}"),n(`
 `),t("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),q=t("h2",{id:"logical-operators",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#logical-operators"},"#"),n(" Logical Operators")],-1),D=t("p",null,[n("You can nest or group multiple rules using the "),t("code",null,"_and"),n(" or "),t("code",null,"_or"),n(" logical operators. Each logical operator holds an array of Filter Rules, allowing for more complex filtering. Also note in the example that Logical Operators can be sub-nested into Logical Operators. However, they cannot be sub-nested into Filter Rules.")],-1),k=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),n(`
+`)])],-1),O=t("h2",{id:"logical-operators",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#logical-operators"},"#"),n(" Logical Operators")],-1),D=t("p",null,[n("You can nest or group multiple rules using the "),t("code",null,"_and"),n(" or "),t("code",null,"_or"),n(" logical operators. Each logical operator holds an array of Filter Rules, allowing for more complex filtering. Also note in the example that Logical Operators can be sub-nested into Logical Operators. However, they cannot be sub-nested into Filter Rules.")],-1),k=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),n(`
 	`),t("span",{class:"hljs-attr"},'"_or"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"["),n(`
 		`),t("span",{class:"hljs-punctuation"},"{"),n(`
 			`),t("span",{class:"hljs-attr"},'"_and"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"["),n(`
@@ -82,4 +82,4 @@ import{a as l,o as c,b as i,w as a,l as t,E as n,e as r}from"./runtime-core.esm-
 		`),t("span",{class:"hljs-punctuation"},"}"),n(`
 	`),t("span",{class:"hljs-punctuation"},"}"),n(`
 `),t("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),L=t("p",null,"will fetch all parent items that don\u2019t have the category \u201CRecipe\u201D",-1),V=t("h2",{id:"dynamic-variables",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#dynamic-variables"},"#"),n(" Dynamic Variables")],-1),M=t("p",null,[n("In addition to static values, you can also filter against "),t("em",null,"dynamic"),n(" values using the following variables.")],-1),W=t("ul",null,[t("li",null,[t("code",null,"$CURRENT_USER"),n(" \u2014 The primary key of the currently authenticated user")]),t("li",null,[t("code",null,"$CURRENT_ROLE"),n(" \u2014 The primary key of the role for the currently authenticated user")]),t("li",null,[t("code",null,"$NOW"),n(" \u2014 The current timestamp")]),t("li",null,[t("code",null,"$NOW(<adjustment>)"),n(" - The current timestamp plus/minus a given distance, for example "),t("code",null,"$NOW(-1 year)"),n(", "),t("code",null,"$NOW(+2 hours)")])],-1),A={class:"tip hint"},G=t("div",{class:"hint-title"},"Functions",-1),P=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Nested User / Role variables in Permissions"),t("p",null,[n("When configuring permissions, "),t("code",null,"$CURRENT_USER"),n(" and "),t("code",null,"$CURRENT_ROLE"),n(" allow you to specify any (nested) field under the current user/role as well as the root ID. For example: "),t("code",null,"$CURRENT_ROLE.name"),n(" or "),t("code",null,"$CURRENT_USER.avatar.filesize"),n(". This includes custom fields that were added to the directus_users/directus_roles tables.")]),t("p",null,"Note: This feature is only available for permissions, validation, and presets. Regular filters and conditional fields currently only support the root ID.")],-1),Z="Filter Rules",z=!1,H="REST and GraphQL API documentation for filter rules in Directus.",K="5 min read",X={__name:"filter-rules",setup(B,{expose:e}){const s={title:"Filter Rules",modularExtension:!1,description:"REST and GraphQL API documentation for filter rules in Directus.",readTime:"5 min read"};return e({frontmatter:s}),(Y,J)=>{const u=l("router-link"),o=l("docs-wrapper");return c(),i(o,{frontmatter:s},{default:a(()=>[t("div",p,[h,d,j,_,f,m,g,b,y,v,R,w,x,E,T,I,N,O,q,D,k,U,F,S,$,C,L,V,M,W,t("div",A,[G,t("p",null,[n("You can also use "),r(u,{to:"/docs/reference/query#functions"},{default:a(()=>[n("Function Parameters")]),_:1}),n(" when building Filters.")])]),P])]),_:1})}}};export{X as default,H as description,z as modularExtension,K as readTime,Z as title};
+`)])],-1),L=t("p",null,"will fetch all parent items that don\u2019t have the category \u201CRecipe\u201D",-1),V=t("h2",{id:"dynamic-variables",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#dynamic-variables"},"#"),n(" Dynamic Variables")],-1),M=t("p",null,[n("In addition to static values, you can also filter against "),t("em",null,"dynamic"),n(" values using the following variables.")],-1),W=t("ul",null,[t("li",null,[t("code",null,"$CURRENT_USER"),n(" \u2014 The primary key of the currently authenticated user")]),t("li",null,[t("code",null,"$CURRENT_ROLE"),n(" \u2014 The primary key of the role for the currently authenticated user")]),t("li",null,[t("code",null,"$NOW"),n(" \u2014 The current timestamp")]),t("li",null,[t("code",null,"$NOW(<adjustment>)"),n(" - The current timestamp plus/minus a given distance, for example "),t("code",null,"$NOW(-1 year)"),n(", "),t("code",null,"$NOW(+2 hours)")])],-1),A={class:"tip hint"},G=t("div",{class:"hint-title"},"Functions",-1),P=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Nested User / Role variables in Permissions"),t("p",null,[n("When configuring permissions, "),t("code",null,"$CURRENT_USER"),n(" and "),t("code",null,"$CURRENT_ROLE"),n(" allow you to specify any (nested) field under the current user/role as well as the root ID. For example: "),t("code",null,"$CURRENT_ROLE.name"),n(" or "),t("code",null,"$CURRENT_USER.avatar.filesize"),n(". This includes custom fields that were added to the directus_users/directus_roles tables.")]),t("p",null,"Note: This feature is only available for permissions, validation, and presets. Regular filters and conditional fields currently only support the root ID.")],-1),Q="Filter Rules",Z=!1,H="REST and GraphQL API documentation for filter rules in Directus.",K="5 min read",X={__name:"filter-rules",setup(B,{expose:e}){const s={title:"Filter Rules",modularExtension:!1,description:"REST and GraphQL API documentation for filter rules in Directus.",readTime:"5 min read"};return e({frontmatter:s}),(Y,z)=>{const u=l("router-link"),o=l("docs-wrapper");return c(),i(o,{frontmatter:s},{default:a(()=>[t("div",p,[h,d,j,_,f,m,g,b,y,v,R,w,x,E,T,I,N,q,O,D,k,U,F,S,$,C,L,V,M,W,t("div",A,[G,t("p",null,[n("You can also use "),r(u,{to:"/docs/reference/query#functions"},{default:a(()=>[n("Function Parameters")]),_:1}),n(" when building Filters.")])]),P])]),_:1})}}};export{X as default,H as description,Z as modularExtension,K as readTime,Q as title};

package/dist/assets/{filters.98d31bd5.js → filters.26e88a50.js}

@@ -1 +1 @@
-import{a as n,o as d,b as c,w as o,l as e,E as t,e as i}from"./runtime-core.esm-bundler.fe249c5c.js";const u={class:"markdown-body"},h=e("blockquote",null,[e("p",null,"Filters allow you to conditionally select Items from a Collection. Use-cases include customizing Item search results, restricting Item access permissions for specific Users or Roles, building dashboard analytics with the Insights module, and more.")],-1),p=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/filters-20220303A.webp",alt:"Filters"})],-1),f={class:"warning hint"},m=e("div",{class:"hint-title"},"There Are Two Filters Documents",-1),_=e("h2",{id:"how-it-works",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#how-it-works"},"#"),t(" How it Works")],-1),g={class:"tip hint"},y=e("div",{class:"hint-title"},"Assumed Knowledge",-1),b=e("strong",null,"Field",-1),w=e("strong",null,"Value",-1),F=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"How Filters Work"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/how-filters-work-20220303A.mp4",type:"video/mp4"})],-1),v=e("ol",{start:"2"},[e("li",null,[t("Click "),e("span",{mi:"",icon:""},"filter_list"),t(" or "),e("strong",null,"\u201CAdd Filter\u201D"),t(".")]),e("li",null,"Select the Field to filter by."),e("li",null,"Select the Operator as desired."),e("li",null,"Define the Value to filter for.")],-1),C=e("p",null,[t("From here, you can set multiple Filters at once, filter by "),e("a",{href:"#filtering-by-related-collections"},"Fields in related Collections"),t(", set Values with "),e("a",{href:"#dynamic-variables"},"Dynamic Variables"),t(", as well as apply "),e("a",{href:"#and-or-groups"},"AND/OR Groups"),t(".")],-1),A={class:"tip hint"},k=e("div",{class:"hint-title"},"Operators",-1),x=e("a",{href:"#unfilterable-fields"},"Unfilterable Fields",-1),R=e("h2",{id:"and%2For-groups",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#and%2For-groups"},"#"),t(" AND/OR Groups")],-1),O=e("p",null,[e("code",null,"AND"),t(" Groups give the option to filter for Items that meet "),e("em",null,"all of several criteria"),t(". On the other hand, "),e("code",null,"OR"),t(" Groups filter for Items that meet "),e("em",null,"any one of several criteria"),t(".")],-1),I=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/and-or-groups-20220303A.webp",alt:"AND/OR Groups"})],-1),D=e("ol",null,[e("li",null,"Click \u201CAdd Filter\u201D."),e("li",null,"Click \u201CAnd/OR Group\u201D at the very top of the dropdown menu."),e("li",null,[t("Click the AND/OR text to toggle: "),e("ul",null,[e("li",null,[e("code",null,"AND"),t(" \u2013 Selects Items that meet every single criteria.")]),e("li",null,[e("code",null,"OR"),t(" \u2013 Selects Items that meet one of several criteria.")])])]),e("li",null,"Click \u201CAdd Filter\u201D again."),e("li",null,"Configure the Field, Operator, and Value as desired."),e("li",null,[t("Click and hold "),e("span",{mi:"",icon:""},"drag_indicator"),t(" to drag a Filter and nest it under an AND/OR Group.")])],-1),N=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Why do we need AND Groups?"),e("p",null,[t("Filters actually default to "),e("code",null,"AND"),t(" Group behavior automatically. However, when Filters are nested inside of an OR Group, they of course switch to "),e("code",null,"OR"),t(" Group behavior. So an AND Group is necessary in cases where you want to meet multiple conditions inside of OR Groups.")])],-1),G=e("h2",{id:"dynamic-variables",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#dynamic-variables"},"#"),t(" Dynamic Variables")],-1),T=e("p",null,"The following video shows how to filter for Blog posts written within the past 60 days.",-1),U=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"How Filters Work"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/dynamic-variables-20220307A.mp4",type:"video/mp4"})],-1),E=e("code",null,"$CURRENT_USER",-1),V=e("code",null,"$CURRENT_ROLE",-1),H=e("code",null,"$NOW",-1),S=e("code",null,"$NOW(<adjustment>)",-1),W=e("h2",{id:"filtering-by-related-collections",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#filtering-by-related-collections"},"#"),t(" Filtering by Related Collections")],-1),B=e("p",null,[t("You may need to run filters on one Collection "),e("em",null,"based on information in another related Collection"),t(". Here are a few examples of when that might happen:")],-1),$=e("ul",null,[e("li",null,[t("Book authors that also wrote screenplays (filters "),e("code",null,"authors"),t(", uses "),e("code",null,"screenplays"),t(").")]),e("li",null,[t("Products with a 5 star customer review (filters "),e("code",null,"products"),t(", uses "),e("code",null,"reviews"),t(").")]),e("li",null,[t("Accounts with active user login within the last 12 months (filters "),e("code",null,"accounts"),t(", uses "),e("code",null,"logins"),t(").")])],-1),j=e("p",null,[t("This can span across any number of relationally linked Collections. For example, you could filter for customers that bought rock songs, where the "),e("code",null,"customers"),t(" and "),e("code",null,"genres"),t(" Collections are linked by "),e("code",null,"customers"),t(" -> "),e("code",null,"invoices"),t(" -> "),e("code",null,"invoice-items"),t(" -> "),e("code",null,"tracks"),t(" -> "),e("code",null,"genres"),t(".")],-1),z=e("span",{mi:"",icon:""},"chevron_right",-1),P=e("p",null,"Here are step-by-step instructions on how to filter by Fields in other Collections:",-1),q=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"How Filters Work"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/filtering-by-related-collections-20220303A.mp4",type:"video/mp4"})],-1),L=e("ol",null,[e("li",null,"Click \u201CAdd Filter\u201D."),e("li",null,"Click the desired relational Field. This will pop down and display the related Collection Fields."),e("li",null,"Select a Field from this related Collection."),e("li",null,"Set the Operator and Value as desired.")],-1),Y=e("h2",{id:"unfilterable-fields",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#unfilterable-fields"},"#"),t(" Unfilterable Fields")],-1),K=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/unfilterable-fields-20220303A.webp",alt:"Unfilterable Fields"})],-1),M=e("p",null,[t("Not all Fields can be filtered. As seen above in "),e("a",{href:"#filtering-by-related-collections"},"Filtering by Related Collections"),t(", Alias Fields cannot be filtered; they instead provide a dropdown menu to access Fields from a related Collection. Additionally, the \u201CPresentation\u201D and \u201CGroup\u201D Fields cannot be filtered at all and will not appear as an option in Filters.")],-1),J=e("h2",{id:"extensibility-options",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#extensibility-options"},"#"),t(" Extensibility Options")],-1),Q=e("p",null,"Directus Core is completely open-source, modular and extensible. Extensions allow you to expand or modify any part of Directus to fit your needs. Here are some great resources to get started down that track.",-1),X=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Accelerated Development"),e("p",null,[t("Working on an enterprise project and looking to outsource or financially sponsor the development of a Shares extension? Contact "),e("a",{href:"https://directus.io/contact",target:"_blank",rel:"noopener noreferrer"},"our team")])],-1),Z=e("h2",{id:"more-help",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#more-help"},"#"),t(" More Help")],-1),ee=e("p",null,[t("Looking for technical support for your non-enterprise project? Chat with thousands of engineers within our growing "),e("a",{href:"https://discord.com/invite/directus",target:"_blank",rel:"noopener noreferrer"},"Community on Discord")],-1),se="Filters",ne=!1,re="Filters allow you to conditionally select Items from a Collection. Use-cases include customizing Item search results restricting Item access permissions for specific Users or Roles, building dashboard analytics with the Insights module, and more.",ae="5 min read",de={__name:"filters",setup(te,{expose:r}){const s={title:"Filters",modularExtension:!1,description:"Filters allow you to conditionally select Items from a Collection. Use-cases include customizing Item search results restricting Item access permissions for specific Users or Roles, building dashboard analytics with the Insights module, and more.",readTime:"5 min read"};return r({frontmatter:s}),(oe,le)=>{const l=n("router-link"),a=n("docs-wrapper");return d(),c(a,{frontmatter:s},{default:o(()=>[e("div",u,[h,p,e("div",f,[m,e("p",null,[t("This page is a non-technical guide to using Filters. For more technical info, see "),i(l,{to:"/docs/reference/filter-rules"},{default:o(()=>[t("Filter-Rules")]),_:1}),t(".")])]),_,e("div",g,[y,e("p",null,[t("Filters are intuitive to use, but get quite nuanced as complexity increases. In order to use Filters effectively, you will need to understand the Field "),e("em",null,[t("(aka "),i(l,{to:"/docs/configuration/data-model"},{default:o(()=>[t("data model")]),_:1}),t(")")]),t(" being filtered as well as any relevant "),i(l,{to:"/docs/configuration/users-roles-permissions.md"},{default:o(()=>[t("Users, Roles and Permissions")]),_:1}),t(".")])]),e("p",null,[t("A basic filter is composed of 3 parts: A "),b,t(" from the Collection being Filtered, a logical "),i(l,{to:"/docs/reference/filter-rules#filter-operators"},{default:o(()=>[t("Operator")]),_:1}),t(", and some specified "),w,t(" to filter for within each Item\u2019s Field.")]),F,v,C,e("div",A,[k,e("p",null,[t("The Field type will determine the kinds of Operators that can be used on it. In fact, some Fields cannot be filtered at all (read more in "),x,t("). Once a Field is selected, the permitted operators will automatically display. An exhaustive list of Operators and what they do can be found in the more technical "),i(l,{to:"/docs/reference/filter-rules#filter-operators"},{default:o(()=>[t("Filter Rules")]),_:1}),t(" document.")])]),R,O,I,D,N,G,T,U,e("p",null,[t("The following Dynamic Variables are built into Directus to make Filtering easier: "),E,t(", "),V,t(", "),H,t(" and "),S,t(". For more information, please see the Dynamic Variables section in "),i(l,{to:"/docs/reference/filter-rules"},{default:o(()=>[t("Filter Rules")]),_:1}),t(".")]),W,B,$,j,e("p",null,[t("You will notice a "),z,t(" icon beside relational Fields. When you click on any "),i(l,{to:"/docs/getting-started/glossary#alias"},{default:o(()=>[t("Alias")]),_:1}),t(" Field, all the Fields for that associated Collection pop down. If you select one of these Fields, you can run Filters on the current Collection by Field values in a related Collection.")]),P,q,L,Y,K,M,J,Q,e("ul",null,[e("li",null,[i(l,{to:"/docs/extensions/introduction"},{default:o(()=>[t("Extensions > Introduction")]),_:1})]),e("li",null,[i(l,{to:"/docs/extensions/creating-extensions"},{default:o(()=>[t("Extensions > Creating Extensions")]),_:1})]),e("li",null,[i(l,{to:"/docs/contributing/introduction"},{default:o(()=>[t("Contributing > Introduction")]),_:1})]),e("li",null,[i(l,{to:"/docs/contributing/codebase-overview"},{default:o(()=>[t("Contributing > Codebase Overview")]),_:1})])]),X,Z,ee])]),_:1})}}};export{de as default,re as description,ne as modularExtension,ae as readTime,se as title};
+import{a as n,o as d,e as c,y as o,u as e,q as t,z as i}from"./runtime-core.esm-bundler.22ec0346.js";const u={class:"markdown-body"},h=e("blockquote",null,[e("p",null,"Filters allow you to conditionally select Items from a Collection. Use-cases include customizing Item search results, restricting Item access permissions for specific Users or Roles, building dashboard analytics with the Insights module, and more.")],-1),p=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/filters-20220303A.webp",alt:"Filters"})],-1),f={class:"warning hint"},m=e("div",{class:"hint-title"},"There Are Two Filters Documents",-1),_=e("h2",{id:"how-it-works",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#how-it-works"},"#"),t(" How it Works")],-1),y={class:"tip hint"},g=e("div",{class:"hint-title"},"Assumed Knowledge",-1),b=e("strong",null,"Field",-1),w=e("strong",null,"Value",-1),F=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"How Filters Work"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/how-filters-work-20220303A.mp4",type:"video/mp4"})],-1),v=e("ol",{start:"2"},[e("li",null,[t("Click "),e("span",{mi:"",icon:""},"filter_list"),t(" or "),e("strong",null,"\u201CAdd Filter\u201D"),t(".")]),e("li",null,"Select the Field to filter by."),e("li",null,"Select the Operator as desired."),e("li",null,"Define the Value to filter for.")],-1),C=e("p",null,[t("From here, you can set multiple Filters at once, filter by "),e("a",{href:"#filtering-by-related-collections"},"Fields in related Collections"),t(", set Values with "),e("a",{href:"#dynamic-variables"},"Dynamic Variables"),t(", as well as apply "),e("a",{href:"#and-or-groups"},"AND/OR Groups"),t(".")],-1),A={class:"tip hint"},k=e("div",{class:"hint-title"},"Operators",-1),x=e("a",{href:"#unfilterable-fields"},"Unfilterable Fields",-1),R=e("h2",{id:"and%2For-groups",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#and%2For-groups"},"#"),t(" AND/OR Groups")],-1),O=e("p",null,[e("code",null,"AND"),t(" Groups give the option to filter for Items that meet "),e("em",null,"all of several criteria"),t(". On the other hand, "),e("code",null,"OR"),t(" Groups filter for Items that meet "),e("em",null,"any one of several criteria"),t(".")],-1),I=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/and-or-groups-20220303A.webp",alt:"AND/OR Groups"})],-1),D=e("ol",null,[e("li",null,"Click \u201CAdd Filter\u201D."),e("li",null,"Click \u201CAnd/OR Group\u201D at the very top of the dropdown menu."),e("li",null,[t("Click the AND/OR text to toggle: "),e("ul",null,[e("li",null,[e("code",null,"AND"),t(" \u2013 Selects Items that meet every single criteria.")]),e("li",null,[e("code",null,"OR"),t(" \u2013 Selects Items that meet one of several criteria.")])])]),e("li",null,"Click \u201CAdd Filter\u201D again."),e("li",null,"Configure the Field, Operator, and Value as desired."),e("li",null,[t("Click and hold "),e("span",{mi:"",icon:""},"drag_indicator"),t(" to drag a Filter and nest it under an AND/OR Group.")])],-1),N=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Why do we need AND Groups?"),e("p",null,[t("Filters actually default to "),e("code",null,"AND"),t(" Group behavior automatically. However, when Filters are nested inside of an OR Group, they of course switch to "),e("code",null,"OR"),t(" Group behavior. So an AND Group is necessary in cases where you want to meet multiple conditions inside of OR Groups.")])],-1),G=e("h2",{id:"dynamic-variables",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#dynamic-variables"},"#"),t(" Dynamic Variables")],-1),T=e("p",null,"The following video shows how to filter for Blog posts written within the past 60 days.",-1),U=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"How Filters Work"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/dynamic-variables-20220307A.mp4",type:"video/mp4"})],-1),V=e("code",null,"$CURRENT_USER",-1),E=e("code",null,"$CURRENT_ROLE",-1),H=e("code",null,"$NOW",-1),S=e("code",null,"$NOW(<adjustment>)",-1),W=e("h2",{id:"filtering-by-related-collections",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#filtering-by-related-collections"},"#"),t(" Filtering by Related Collections")],-1),B=e("p",null,[t("You may need to run filters on one Collection "),e("em",null,"based on information in another related Collection"),t(". Here are a few examples of when that might happen:")],-1),z=e("ul",null,[e("li",null,[t("Book authors that also wrote screenplays (filters "),e("code",null,"authors"),t(", uses "),e("code",null,"screenplays"),t(").")]),e("li",null,[t("Products with a 5 star customer review (filters "),e("code",null,"products"),t(", uses "),e("code",null,"reviews"),t(").")]),e("li",null,[t("Accounts with active user login within the last 12 months (filters "),e("code",null,"accounts"),t(", uses "),e("code",null,"logins"),t(").")])],-1),$=e("p",null,[t("This can span across any number of relationally linked Collections. For example, you could filter for customers that bought rock songs, where the "),e("code",null,"customers"),t(" and "),e("code",null,"genres"),t(" Collections are linked by "),e("code",null,"customers"),t(" -> "),e("code",null,"invoices"),t(" -> "),e("code",null,"invoice-items"),t(" -> "),e("code",null,"tracks"),t(" -> "),e("code",null,"genres"),t(".")],-1),j=e("span",{mi:"",icon:""},"chevron_right",-1),q=e("p",null,"Here are step-by-step instructions on how to filter by Fields in other Collections:",-1),P=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"How Filters Work"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/filtering-by-related-collections-20220303A.mp4",type:"video/mp4"})],-1),L=e("ol",null,[e("li",null,"Click \u201CAdd Filter\u201D."),e("li",null,"Click the desired relational Field. This will pop down and display the related Collection Fields."),e("li",null,"Select a Field from this related Collection."),e("li",null,"Set the Operator and Value as desired.")],-1),Y=e("h2",{id:"unfilterable-fields",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#unfilterable-fields"},"#"),t(" Unfilterable Fields")],-1),K=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/unfilterable-fields-20220303A.webp",alt:"Unfilterable Fields"})],-1),M=e("p",null,[t("Not all Fields can be filtered. As seen above in "),e("a",{href:"#filtering-by-related-collections"},"Filtering by Related Collections"),t(", Alias Fields cannot be filtered; they instead provide a dropdown menu to access Fields from a related Collection. Additionally, the \u201CPresentation\u201D and \u201CGroup\u201D Fields cannot be filtered at all and will not appear as an option in Filters.")],-1),J=e("h2",{id:"extensibility-options",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#extensibility-options"},"#"),t(" Extensibility Options")],-1),Q=e("p",null,"Directus Core is completely open-source, modular and extensible. Extensions allow you to expand or modify any part of Directus to fit your needs. Here are some great resources to get started down that track.",-1),X=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Accelerated Development"),e("p",null,[t("Working on an enterprise project and looking to outsource or financially sponsor the development of a Shares extension? Contact "),e("a",{href:"https://directus.io/contact",target:"_blank",rel:"noopener noreferrer"},"our team")])],-1),Z=e("h2",{id:"more-help",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#more-help"},"#"),t(" More Help")],-1),ee=e("p",null,[t("Looking for technical support for your non-enterprise project? Chat with thousands of engineers within our growing "),e("a",{href:"https://discord.com/invite/directus",target:"_blank",rel:"noopener noreferrer"},"Community on Discord")],-1),se="Filters",ne=!1,re="Filters allow you to conditionally select Items from a Collection. Use-cases include customizing Item search results restricting Item access permissions for specific Users or Roles, building dashboard analytics with the Insights module, and more.",ae="5 min read",de={__name:"filters",setup(te,{expose:r}){const s={title:"Filters",modularExtension:!1,description:"Filters allow you to conditionally select Items from a Collection. Use-cases include customizing Item search results restricting Item access permissions for specific Users or Roles, building dashboard analytics with the Insights module, and more.",readTime:"5 min read"};return r({frontmatter:s}),(oe,le)=>{const l=n("router-link"),a=n("docs-wrapper");return d(),c(a,{frontmatter:s},{default:o(()=>[e("div",u,[h,p,e("div",f,[m,e("p",null,[t("This page is a non-technical guide to using Filters. For more technical info, see "),i(l,{to:"/docs/reference/filter-rules"},{default:o(()=>[t("Filter-Rules")]),_:1}),t(".")])]),_,e("div",y,[g,e("p",null,[t("Filters are intuitive to use, but get quite nuanced as complexity increases. In order to use Filters effectively, you will need to understand the Field "),e("em",null,[t("(aka "),i(l,{to:"/docs/configuration/data-model"},{default:o(()=>[t("data model")]),_:1}),t(")")]),t(" being filtered as well as any relevant "),i(l,{to:"/docs/configuration/users-roles-permissions.md"},{default:o(()=>[t("Users, Roles and Permissions")]),_:1}),t(".")])]),e("p",null,[t("A basic filter is composed of 3 parts: A "),b,t(" from the Collection being Filtered, a logical "),i(l,{to:"/docs/reference/filter-rules#filter-operators"},{default:o(()=>[t("Operator")]),_:1}),t(", and some specified "),w,t(" to filter for within each Item\u2019s Field.")]),F,v,C,e("div",A,[k,e("p",null,[t("The Field type will determine the kinds of Operators that can be used on it. In fact, some Fields cannot be filtered at all (read more in "),x,t("). Once a Field is selected, the permitted operators will automatically display. An exhaustive list of Operators and what they do can be found in the more technical "),i(l,{to:"/docs/reference/filter-rules#filter-operators"},{default:o(()=>[t("Filter Rules")]),_:1}),t(" document.")])]),R,O,I,D,N,G,T,U,e("p",null,[t("The following Dynamic Variables are built into Directus to make Filtering easier: "),V,t(", "),E,t(", "),H,t(" and "),S,t(". For more information, please see the Dynamic Variables section in "),i(l,{to:"/docs/reference/filter-rules"},{default:o(()=>[t("Filter Rules")]),_:1}),t(".")]),W,B,z,$,e("p",null,[t("You will notice a "),j,t(" icon beside relational Fields. When you click on any "),i(l,{to:"/docs/getting-started/glossary#alias"},{default:o(()=>[t("Alias")]),_:1}),t(" Field, all the Fields for that associated Collection pop down. If you select one of these Fields, you can run Filters on the current Collection by Field values in a related Collection.")]),q,P,L,Y,K,M,J,Q,e("ul",null,[e("li",null,[i(l,{to:"/docs/extensions/introduction"},{default:o(()=>[t("Extensions > Introduction")]),_:1})]),e("li",null,[i(l,{to:"/docs/extensions/creating-extensions"},{default:o(()=>[t("Extensions > Creating Extensions")]),_:1})]),e("li",null,[i(l,{to:"/docs/contributing/introduction"},{default:o(()=>[t("Contributing > Introduction")]),_:1})]),e("li",null,[i(l,{to:"/docs/contributing/codebase-overview"},{default:o(()=>[t("Contributing > Codebase Overview")]),_:1})])]),X,Z,ee])]),_:1})}}};export{de as default,re as description,ne as modularExtension,ae as readTime,se as title};

package/dist/assets/{flows.b6ebb4b6.js → flows.8c6f69bb.js}

@@ -1,4 +1,4 @@
-import{a as o,o as h,b as i,w as e,l as s,E as a,e as n}from"./runtime-core.esm-bundler.fe249c5c.js";const d={class:"markdown-body"},p=s("blockquote",null,[s("p",null,"Flows enable custom, event-driven data processing and task automation within Directus.")],-1),u=s("hr",null,null,-1),_=s("h2",{id:"the-data-chain",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#the-data-chain"},"#"),a(" The Data Chain")],-1),f=s("p",null,[s("code",null,"id"),a(),s("strong",null,"uuid"),s("br"),a(" Primary key of the flow.")],-1),g=s("p",null,[s("code",null,"name"),a(),s("strong",null,"string"),s("br"),a(" Name for the flow.")],-1),m=s("p",null,[s("code",null,"icon"),a(),s("strong",null,"string"),s("br"),a(" Icon displayed in the Admin App for the flow.")],-1),j=s("p",null,[s("code",null,"color"),a(),s("strong",null,"string"),s("br"),a(" Color of the icon displayed in the Admin App for the flow.")],-1),w=s("p",null,[s("code",null,"note"),a(),s("strong",null,"text"),s("br"),a(" Short description displayed in the Admin App.")],-1),b=s("p",null,[s("code",null,"status"),a(),s("strong",null,"string"),s("br"),a(" Current status of the flow. One of "),s("code",null,"active"),a(", "),s("code",null,"inactive"),a(". Defaults to "),s("code",null,"active"),a(" when not specified.")],-1),y=s("p",null,[s("code",null,"trigger"),a(),s("strong",null,"string"),s("br"),a(" Type of trigger for the flow. One of "),s("code",null,"hook"),a(", "),s("code",null,"webhook"),a(", "),s("code",null,"operation"),a(", "),s("code",null,"schedule"),a(", "),s("code",null,"manual"),a(".")],-1),x=s("p",null,[s("code",null,"options"),a(),s("strong",null,"json"),s("br"),a(" Options of the selected trigger for the flow.")],-1),q=s("p",null,[s("code",null,"accountability"),a(),s("strong",null,"string"),s("br"),a(" The permission used during the flow. One of "),s("code",null,"$public"),a(", "),s("code",null,"$trigger"),a(", "),s("code",null,"$full"),a(", or UUID of a role.")],-1),E=s("p",null,[s("code",null,"date_created"),a(),s("strong",null,"timestamp"),s("br"),a(" Timestamp in ISO8601 when the flow was created.")],-1),T=s("code",null,"user_created",-1),P=s("strong",null,"many-to-one",-1),k=s("br",null,null,-1),S=s("p",null,[s("code",null,"operation"),a(),s("strong",null,"string"),s("br"),a(" UUID of the operation connected to the trigger in the flow.")],-1),R=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),a(`
+import{a as o,o as h,e as i,y as e,u as s,q as a,z as n}from"./runtime-core.esm-bundler.22ec0346.js";const d={class:"markdown-body"},p=s("blockquote",null,[s("p",null,"Flows enable custom, event-driven data processing and task automation within Directus.")],-1),u=s("hr",null,null,-1),_=s("h2",{id:"the-data-chain",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#the-data-chain"},"#"),a(" The Data Chain")],-1),f=s("p",null,[s("code",null,"id"),a(),s("strong",null,"uuid"),s("br"),a(" Primary key of the flow.")],-1),g=s("p",null,[s("code",null,"name"),a(),s("strong",null,"string"),s("br"),a(" Name for the flow.")],-1),m=s("p",null,[s("code",null,"icon"),a(),s("strong",null,"string"),s("br"),a(" Icon displayed in the Admin App for the flow.")],-1),j=s("p",null,[s("code",null,"color"),a(),s("strong",null,"string"),s("br"),a(" Color of the icon displayed in the Admin App for the flow.")],-1),w=s("p",null,[s("code",null,"note"),a(),s("strong",null,"text"),s("br"),a(" Short description displayed in the Admin App.")],-1),b=s("p",null,[s("code",null,"status"),a(),s("strong",null,"string"),s("br"),a(" Current status of the flow. One of "),s("code",null,"active"),a(", "),s("code",null,"inactive"),a(". Defaults to "),s("code",null,"active"),a(" when not specified.")],-1),y=s("p",null,[s("code",null,"trigger"),a(),s("strong",null,"string"),s("br"),a(" Type of trigger for the flow. One of "),s("code",null,"hook"),a(", "),s("code",null,"webhook"),a(", "),s("code",null,"operation"),a(", "),s("code",null,"schedule"),a(", "),s("code",null,"manual"),a(".")],-1),x=s("p",null,[s("code",null,"options"),a(),s("strong",null,"json"),s("br"),a(" Options of the selected trigger for the flow.")],-1),q=s("p",null,[s("code",null,"accountability"),a(),s("strong",null,"string"),s("br"),a(" The permission used during the flow. One of "),s("code",null,"$public"),a(", "),s("code",null,"$trigger"),a(", "),s("code",null,"$full"),a(", or UUID of a role.")],-1),E=s("p",null,[s("code",null,"date_created"),a(),s("strong",null,"timestamp"),s("br"),a(" Timestamp in ISO8601 when the flow was created.")],-1),T=s("code",null,"user_created",-1),P=s("strong",null,"many-to-one",-1),k=s("br",null,null,-1),S=s("p",null,[s("code",null,"operation"),a(),s("strong",null,"string"),s("br"),a(" UUID of the operation connected to the trigger in the flow.")],-1),R=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),a(`
 	`),s("span",{class:"hljs-attr"},'"id"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"2fab3b9d-0543-4b87-8a30-3c5ee66fedf1"'),s("span",{class:"hljs-punctuation"},","),a(`
 	`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"My Flow"'),s("span",{class:"hljs-punctuation"},","),a(`
 	`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"bolt"'),s("span",{class:"hljs-punctuation"},","),a(`
@@ -24,7 +24,7 @@ SEARCH /flows
 		status
 	}
 }
-`)])],-1),H=s("hr",null,null,-1),N=s("h2",{id:"retrieve-a-flow",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#retrieve-a-flow"},"#"),a(" Retrieve a flow")],-1),$=s("p",null,"List an existing flow by primary key.",-1),V=s("h3",{id:"query-parameters-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-1"},"#"),a(" Query Parameters")],-1),Z=s("h3",{id:"returns-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-1"},"#"),a(" Returns")],-1),z=s("p",null,[a("Returns the requested "),s("a",{href:"#the-data-chain"},"data chain"),a(".")],-1),J=s("h3",{id:"rest-api-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-1"},"#"),a(" REST API")],-1),K=s("pre",null,[s("code",null,`GET /flows/:id
+`)])],-1),H=s("hr",null,null,-1),N=s("h2",{id:"retrieve-a-flow",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#retrieve-a-flow"},"#"),a(" Retrieve a flow")],-1),$=s("p",null,"List an existing flow by primary key.",-1),V=s("h3",{id:"query-parameters-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-1"},"#"),a(" Query Parameters")],-1),z=s("h3",{id:"returns-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-1"},"#"),a(" Returns")],-1),Z=s("p",null,[a("Returns the requested "),s("a",{href:"#the-data-chain"},"data chain"),a(".")],-1),J=s("h3",{id:"rest-api-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-1"},"#"),a(" REST API")],-1),K=s("pre",null,[s("code",null,`GET /flows/:id
 `)],-1),W=s("h5",{id:"example-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-1"},"#"),a(" Example")],-1),X=s("pre",null,[s("code",null,`GET /flows/2fc325fb-299b-4d20-a9e7-a34349dee8b2
 `)],-1),Y=s("h3",{id:"graphql-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-1"},"#"),a(" GraphQL")],-1),ss=s("pre",null,[s("code",null,`POST /graphql/system
 `)],-1),as=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),a(` {
@@ -95,8 +95,8 @@ SEARCH /flows
 		status
 	}
 }
-`)])],-1),Cs=s("hr",null,null,-1),Gs=s("h2",{id:"update-a-flow",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-a-flow"},"#"),a(" Update a Flow")],-1),Ms=s("p",null,"Update an existing flow.",-1),Us=s("h3",{id:"query-parameters-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-4"},"#"),a(" Query Parameters")],-1),Bs=s("h3",{id:"request-body-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-2"},"#"),a(" Request Body")],-1),Hs=s("p",null,[a("A partial "),s("a",{href:"#the-data-chain"},"data chain"),a(".")],-1),Ns=s("h3",{id:"returns-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-4"},"#"),a(" Returns")],-1),$s=s("p",null,[a("Returns the "),s("a",{href:"#the-data-chain"},"data chain"),a(" for the updated flow.")],-1),Vs=s("h3",{id:"rest-api-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-4"},"#"),a(" REST API")],-1),Zs=s("pre",null,[s("code",null,`PATCH /flows/:id
-`)],-1),zs=s("h5",{id:"example-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-7"},"#"),a(" Example")],-1),Js=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /flows/2fc325fb-299b-4d20-a9e7-a34349dee8b2"),a(`
+`)])],-1),Cs=s("hr",null,null,-1),Gs=s("h2",{id:"update-a-flow",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-a-flow"},"#"),a(" Update a Flow")],-1),Ms=s("p",null,"Update an existing flow.",-1),Us=s("h3",{id:"query-parameters-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-4"},"#"),a(" Query Parameters")],-1),Bs=s("h3",{id:"request-body-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-2"},"#"),a(" Request Body")],-1),Hs=s("p",null,[a("A partial "),s("a",{href:"#the-data-chain"},"data chain"),a(".")],-1),Ns=s("h3",{id:"returns-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-4"},"#"),a(" Returns")],-1),$s=s("p",null,[a("Returns the "),s("a",{href:"#the-data-chain"},"data chain"),a(" for the updated flow.")],-1),Vs=s("h3",{id:"rest-api-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-4"},"#"),a(" REST API")],-1),zs=s("pre",null,[s("code",null,`PATCH /flows/:id
+`)],-1),Zs=s("h5",{id:"example-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-7"},"#"),a(" Example")],-1),Js=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /flows/2fc325fb-299b-4d20-a9e7-a34349dee8b2"),a(`
 
 `),s("span",{class:"hljs-punctuation"},"{"),a(`
 	`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),a(),s("span",{class:"hljs-string"},'"My Updated Flow"'),a(`
@@ -152,7 +152,7 @@ SEARCH /flows
 `)],-1),Va=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),a(` {
 	delete_flows_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),a(`!]!): delete_many
 }
-`)])],-1),Za=s("h5",{id:"example-14",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-14"},"#"),a(" Example")],-1),za=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(` {
+`)])],-1),za=s("h5",{id:"example-14",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-14"},"#"),a(" Example")],-1),Za=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),a(` {
 	delete_flows_items(
 		ids: [
 			`),s("span",{class:"hljs-string"},'"25821236-8c2a-4f89-8fdc-c7d01f35877d"'),a(`
@@ -169,4 +169,4 @@ SEARCH /flows
 `)])],-1),te=s("h2",{id:"flow-with-post-webhook-trigger",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#flow-with-post-webhook-trigger"},"#"),a(" Flow with POST webhook trigger")],-1),ne=s("p",null,"Start a flow with POST webhook trigger.",-1),le=s("h3",{id:"request-body-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-5"},"#"),a(" Request Body")],-1),oe=s("p",null,"Payload for the POST request.",-1),re=s("h3",{id:"returns-9",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-9"},"#"),a(" Returns")],-1),ce=s("p",null,"Result of the flow, if any.",-1),he=s("h3",{id:"rest-api-9",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-9"},"#"),a(" REST API")],-1),ie=s("pre",null,[s("code",null,`POST /flows/trigger/:flow_uuid
 `)],-1),de=s("h5",{id:"example-16",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-16"},"#"),a(" Example")],-1),pe=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /flows/trigger/202a940b-a00b-47df-b832-369c53f13122"),a(`
 `),s("span",{class:"hljs-comment"},"// Payload here"),a(`
-`)])],-1),me="Flows",je=!1,we="REST and GraphQL API documentation on the Flows collection in Directus.",be="5 min read",ye="page-reference",xe={__name:"flows",setup(ue,{expose:r}){const l={title:"Flows",modularExtension:!1,description:"REST and GraphQL API documentation on the Flows collection in Directus.",readTime:"5 min read",pageClass:"page-reference"};return r({frontmatter:l}),(_e,fe)=>{const t=o("router-link"),c=o("docs-wrapper");return h(),i(c,{frontmatter:l},{default:e(()=>[s("div",d,[p,u,_,f,g,m,j,w,b,y,x,q,E,s("p",null,[T,a(),P,k,a(" The user who created the flow. Many-to-one to "),n(t,{to:"/docs/reference/system/users#the-users-object"},{default:e(()=>[a("users")]),_:1}),a(".")]),S,R,A,F,I,O,s("p",null,[a("Supports all "),n(t,{to:"/docs/reference/query"},{default:e(()=>[a("global query parameters")]),_:1}),a(".")]),D,s("p",null,[a("An array of up to "),n(t,{to:"/docs/reference/query#limit"},{default:e(()=>[a("limit")]),_:1}),a(),v,a(". If no items are available, data will be an empty array.")]),L,Q,s("p",null,[n(t,{to:"/docs/reference/introduction#search-http-method"},{default:e(()=>[a("Learn more about SEARCH ->")]),_:1})]),C,G,M,U,B,H,N,$,V,s("p",null,[a("Supports all "),n(t,{to:"/docs/reference/query"},{default:e(()=>[a("global query parameters")]),_:1}),a(".")]),Z,z,J,K,W,X,Y,ss,as,es,ts,ns,ls,os,rs,s("p",null,[a("Supports all "),n(t,{to:"/docs/reference/query"},{default:e(()=>[a("global query parameters")]),_:1}),a(".")]),cs,hs,is,ds,ps,us,_s,fs,gs,ms,js,ws,bs,ys,xs,qs,Es,s("p",null,[a("Supports all "),n(t,{to:"/docs/reference/query"},{default:e(()=>[a("global query parameters")]),_:1}),a(".")]),Ts,Ps,ks,Ss,Rs,As,Fs,Is,Os,Ds,vs,Ls,Qs,Cs,Gs,Ms,Us,s("p",null,[a("Supports all "),n(t,{to:"/docs/reference/query"},{default:e(()=>[a("global query parameters")]),_:1}),a(".")]),Bs,Hs,Ns,$s,Vs,Zs,zs,Js,Ks,Ws,Xs,Ys,sa,aa,ea,ta,na,s("p",null,[a("Supports all "),n(t,{to:"/docs/reference/query"},{default:e(()=>[a("global query parameters")]),_:1}),a(".")]),la,oa,ra,ca,ha,ia,da,pa,ua,_a,fa,ga,ma,ja,wa,ba,ya,xa,qa,Ea,Ta,Pa,ka,Sa,Ra,Aa,Fa,Ia,Oa,Da,va,La,Qa,Ca,Ga,Ma,Ua,Ba,Ha,Na,$a,Va,Za,za,Ja,Ka,Wa,Xa,Ya,se,ae,ee,te,ne,le,oe,re,ce,he,ie,de,pe])]),_:1})}}};export{xe as default,we as description,je as modularExtension,ye as pageClass,be as readTime,me as title};
+`)])],-1),me="Flows",je=!1,we="REST and GraphQL API documentation on the Flows collection in Directus.",be="5 min read",ye="page-reference",xe={__name:"flows",setup(ue,{expose:r}){const l={title:"Flows",modularExtension:!1,description:"REST and GraphQL API documentation on the Flows collection in Directus.",readTime:"5 min read",pageClass:"page-reference"};return r({frontmatter:l}),(_e,fe)=>{const t=o("router-link"),c=o("docs-wrapper");return h(),i(c,{frontmatter:l},{default:e(()=>[s("div",d,[p,u,_,f,g,m,j,w,b,y,x,q,E,s("p",null,[T,a(),P,k,a(" The user who created the flow. Many-to-one to "),n(t,{to:"/docs/reference/system/users#the-users-object"},{default:e(()=>[a("users")]),_:1}),a(".")]),S,R,A,F,I,O,s("p",null,[a("Supports all "),n(t,{to:"/docs/reference/query"},{default:e(()=>[a("global query parameters")]),_:1}),a(".")]),D,s("p",null,[a("An array of up to "),n(t,{to:"/docs/reference/query#limit"},{default:e(()=>[a("limit")]),_:1}),a(),v,a(". If no items are available, data will be an empty array.")]),L,Q,s("p",null,[n(t,{to:"/docs/reference/introduction#search-http-method"},{default:e(()=>[a("Learn more about SEARCH ->")]),_:1})]),C,G,M,U,B,H,N,$,V,s("p",null,[a("Supports all "),n(t,{to:"/docs/reference/query"},{default:e(()=>[a("global query parameters")]),_:1}),a(".")]),z,Z,J,K,W,X,Y,ss,as,es,ts,ns,ls,os,rs,s("p",null,[a("Supports all "),n(t,{to:"/docs/reference/query"},{default:e(()=>[a("global query parameters")]),_:1}),a(".")]),cs,hs,is,ds,ps,us,_s,fs,gs,ms,js,ws,bs,ys,xs,qs,Es,s("p",null,[a("Supports all "),n(t,{to:"/docs/reference/query"},{default:e(()=>[a("global query parameters")]),_:1}),a(".")]),Ts,Ps,ks,Ss,Rs,As,Fs,Is,Os,Ds,vs,Ls,Qs,Cs,Gs,Ms,Us,s("p",null,[a("Supports all "),n(t,{to:"/docs/reference/query"},{default:e(()=>[a("global query parameters")]),_:1}),a(".")]),Bs,Hs,Ns,$s,Vs,zs,Zs,Js,Ks,Ws,Xs,Ys,sa,aa,ea,ta,na,s("p",null,[a("Supports all "),n(t,{to:"/docs/reference/query"},{default:e(()=>[a("global query parameters")]),_:1}),a(".")]),la,oa,ra,ca,ha,ia,da,pa,ua,_a,fa,ga,ma,ja,wa,ba,ya,xa,qa,Ea,Ta,Pa,ka,Sa,Ra,Aa,Fa,Ia,Oa,Da,va,La,Qa,Ca,Ga,Ma,Ua,Ba,Ha,Na,$a,Va,za,Za,Ja,Ka,Wa,Xa,Ya,se,ae,ee,te,ne,le,oe,re,ce,he,ie,de,pe])]),_:1})}}};export{xe as default,we as description,je as modularExtension,ye as pageClass,be as readTime,me as title};

package/dist/assets/{flows.2646c3ae.js → flows.f014b9cc.js}

@@ -1,4 +1,4 @@
-import{a as l,o as r,b as d,w as n,l as t,E as e,e as s}from"./runtime-core.esm-bundler.fe249c5c.js";const u={class:"markdown-body"},h=t("blockquote",null,[t("p",null,"Flows enable custom, event-driven data processing and task automation within Directus. Each flow is composed of one trigger, followed by a series of operations.")],-1),p={class:"tip hint"},g=t("div",{class:"hint-title"},"Before You Begin",-1),f={class:"tip hint"},w=t("div",{class:"hint-title"},"Learn More",-1),_=t("h2",{id:"what%E2%80%99s-a-flow%3F",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#what%E2%80%99s-a-flow%3F"},"#"),e(" What\u2019s a Flow?")],-1),m=t("p",null,[t("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/flows/flows-20220603A/whats-a-flow-20220603A.webp",alt:"What's a Flow?"})],-1),y=t("p",null,"Each flow is made up of three elements: A trigger, operations, and a data chain.",-1),b=t("h3",{id:"triggers",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#triggers"},"#"),e(),t("strong",null,"Triggers")],-1),v=t("h3",{id:"operations",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#operations"},"#"),e(" Operations")],-1),j=t("em",null,"send off emails, push in-app notifications, send webhooks, and beyond",-1),k=t("p",null,"To put it in conceptual terms, operations do three things:",-1),x=t("ul",null,[t("li",null,[t("strong",null,"Get data"),e(" from Directus or another outside service.")]),t("li",null,[t("strong",null,"Process data"),e(" a.k.a. transform it, validate it, or whatever.")]),t("li",null,[t("strong",null,"Send data"),e(" to Directus or another outside service.")])],-1),T={class:"tip hint"},C=t("div",{class:"hint-title"},"Developers",-1),F=t("h3",{id:"data-chains",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#data-chains"},"#"),e(" Data Chains")],-1),A=t("p",null,[e("In order for a flow\u2019s operations to track and access the same data, each flow creates its own "),t("a",{href:"#the-data-chain"},"data chain"),e(". Every operation has access to this data chain and each operation appends some value onto this object after it runs. This means you can dynamically access data from a previous operation in the current operation with "),t("a",{href:"#data-chain-variables"},"data chain variables"),e(".")],-1),$=t("h3",{id:"control-flow",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#control-flow"},"#"),e(" Control Flow")],-1),D=t("em",null,"fails by design",-1),E=t("p",null,[e("These kinds of failed operations do not immediately stop your flow. Instead, flows let you implement "),t("a",{href:"https://en.wikipedia.org/wiki/Control_flow",target:"_blank",rel:"noopener noreferrer"},"control flow"),e(", by providing "),t("strong",null,"success paths"),e(" and "),t("strong",null,"failure paths"),e(" within a flow:")],-1),N=t("ul",null,[t("li",null,[t("strong",null,"Success"),e(" \u2014 If "),t("code",null,"operation1"),e(" executes successfully, then "),t("code",null,"operation2"),e(" executes.")]),t("li",null,[t("strong",null,"Failure"),e(" \u2014 Else if "),t("code",null,"operation1"),e(" fails on execution, then "),t("code",null,"operation3"),e(" executes.")])],-1),O=t("p",null,[t("em",null,"And there we have it!"),e(" These are the conceptual cornerstones of any flow. Now you\u2019ll need to know how to actually create a flow, which we discuss in the next section.")],-1),S=t("h2",{id:"configure-a-flow",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#configure-a-flow"},"#"),e(" Configure A Flow")],-1),I=t("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"Create a Flow"},[t("source",{src:"https://cdn.directus.io/docs/v9/configuration/flows/flows/flows-20220603A/create-a-flow-20220603A.mp4",type:"video/mp4"})],-1),L=t("h3",{id:"create-a-flow",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#create-a-flow"},"#"),e(" Create a Flow")],-1),Y=t("ol",null,[t("li",null,[e("Navigate to "),t("strong",null,"Settings > Flows"),e(" and click "),t("span",{mi:"",btn:""},"add"),e(" in the page header. A drawer will open.")]),t("li",null,[e("Under "),t("strong",null,"Flow Setup"),e(", fill in a "),t("strong",null,"Name"),e(" for the flow and the following "),t("em",null,"optional"),e(" details: "),t("ul",null,[t("li",null,[t("strong",null,"Status"),e(" \u2014 Sets the flow to active or inactive.")]),t("li",null,[t("strong",null,"Icon"),e(" \u2014 Adds an icon to help quickly identify the flow.")]),t("li",null,[t("strong",null,"Description"),e(" \u2014 Sets a brief verbal description of the flow.")]),t("li",null,[t("strong",null,"Color"),e(" \u2014 Sets a color to help identify the flow.")]),t("li",null,[t("strong",null,"Activity and Logs Tracking"),e(" \u2014 Lets you "),t("strong",null,"Track Activity and Logs"),e(", "),t("strong",null,"Activity"),e(", or "),t("strong",null,"Neither"),e(".")])])])],-1),K={class:"tip hint"},q=t("a",{href:"#logs"},"Logs",-1),R=t("h3",{id:"configure-a-trigger",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#configure-a-trigger"},"#"),e(" Configure a Trigger")],-1),P={start:"3"},W=t("span",{mi:"",btn:""},"arrow_forward",-1),B=t("strong",null,"Trigger Setup",-1),V=t("li",null,[e("Click "),t("span",{mi:"",btn:""},"done"),e(" in the menu header to confirm.")],-1),H=t("p",null,"You\u2019ll now see your trigger in an empty grid area. Its time to start adding operations.",-1),J=t("h3",{id:"configure-an-operation",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#configure-an-operation"},"#"),e(" Configure an Operation")],-1),G={start:"5"},M=t("li",null,[e("On the trigger panel, click "),t("span",{mi:""},"add"),e(" and the "),t("strong",null,"Create Operation"),e(" side drawer will open.")],-1),U=t("strong",null,"Name",-1),z=t("br",null,null,-1),Q=t("a",{href:"#the-data-chain"},"data chain",-1),X=t("br",null,null,-1),Z=t("li",null,[e("Next, click "),t("span",{mi:"",btn:""},"done"),e(" in the page header to confirm and return to the flow grid area.")],-1),tt=t("li",null,[e("From here, you can make the following optional configurations: "),t("ul",null,[t("li",null,[t("strong",null,"Reposition"),e(" \u2014 You can drag and drop panels to reposition as desired.")]),t("li",null,[t("strong",null,"Unlink/Relink"),e(" \u2014 Click and drag "),t("span",{mi:"",icon:"",prmry:""},"adjust"),e(" or "),t("span",{mi:"",icon:"",prmry:""},"arrow_forward"),e(" to unlink/relink flows.")]),t("li",null,[t("strong",null,"Duplicate an Operation"),e(" \u2014 To duplicate an operation, click "),t("span",{mi:"",icon:""},"more_vert"),e(" to open its context menu. Click "),t("span",{mi:"",icon:""},"control_point_duplicate"),e(" and a duplicate of the operation (and its configuration details) will be created.")]),t("li",null,[t("strong",null,"Copy an Operation"),e(" \u2014 To copy and paste an operation into another flow, click "),t("span",{mi:"",icon:""},"more_vert"),e(" to open its context menu. Click "),t("span",{mi:"",icon:""},"input"),e(" and a popup menu will open. Choose the desired flow from the dropdown and click "),t("strong",null,"Copy"),e(".")]),t("li",null,[t("strong",null,[t("span",{mi:"",icon:""},"data_object"),e(" Toggle Raw Editor")]),e(" \u2014 Click "),t("span",{mi:"",icon:""},"data_object"),e(" on an operations\u2019 form input fields to toggle the input type between standard and raw value. This is allows you to add a raw value or "),t("a",{href:"#data-chain-variables"},"Data Chain Variables"),e(" within any type of configuration option, even dropdown menus, checkboxes, and radio buttons.")]),t("li",null,[t("strong",null,"Delete an Operation"),e(" \u2014 To delete an operation, click "),t("span",{mi:"",icon:""},"more_vert"),e(" then "),t("span",{mi:"",icon:"",dngr:""},"delete"),e(". A popup menu will appear. Click "),t("strong",null,"Delete"),e(" to confirm.")])])],-1),et=t("li",null,[e("On the newly created operation panel: "),t("ul",null,[t("li",null,[e("Click "),t("span",{mi:"",icon:""},"add"),e(" to add an operation to the "),t("strong",null,"success path"),e(".")]),t("li",null,[e("Click "),t("span",{mi:"",icon:""},"remove"),e(" to add an operation to the "),t("strong",null,"failure path"),e(".")])])],-1),nt=t("li",null,"Repeat steps 5-10 to build out your flow as desired.",-1),ot=t("li",null,[e("Click "),t("span",{mi:"",btn:""},"done"),e(" to confirm and create your flow.")],-1),st=t("li",null,[e("Click "),t("span",{mi:"",btn:""},"arrow_back"),e(" to return to the flows list.")],-1),at=t("li",null,"Once created, you may need to re-edit your flow, toggle it to inactive, or delete it.",-1),lt=t("h3",{id:"edit-a-flow",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#edit-a-flow"},"#"),e(" Edit a Flow")],-1),it=t("ol",null,[t("li",null,"Navigate to the desired flow."),t("li",null,[e("Click "),t("span",{mi:"",btn:"",muted:""},"edit"),e(" in the flow page header and make reconfigurations as desired.")]),t("li",null,[e("Click "),t("span",{mi:"",btn:""},"done"),e(" to confirm.")])],-1),ct=t("h3",{id:"toggle-a-flow-to-inactive",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#toggle-a-flow-to-inactive"},"#"),e(" Toggle a Flow to Inactive")],-1),rt=t("ol",null,[t("li",null,[e("Navigate to "),t("strong",null,"Settings > Flows"),e(" and click "),t("span",{mi:"",icon:""},"more_vert"),e(" on the desired flow.")]),t("li",null,[e("Click "),t("strong",null,[t("span",{mi:"",icon:""},"check"),e(" Set Flow to Active")]),e(" or "),t("strong",null,[t("span",{mi:"",icon:""},"block"),e(" Set Flow to Inactive")]),e(".")])],-1),dt=t("h3",{id:"delete-a-flow",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#delete-a-flow"},"#"),e(" Delete a Flow")],-1),ut=t("ol",null,[t("li",null,[e("Click "),t("span",{mi:"",icon:""},"more_vert"),e(" on the desired flow to open its context menu.")]),t("li",null,[e("Click "),t("span",{mi:"",icon:"",dngr:""},"delete"),e(" and a popup menu will appear. Click "),t("strong",null,"Delete"),e(" to confirm.")])],-1),ht=t("p",null,"Now that we know how to create and configure a flow, it\u2019s time to get a firmer understanding of the data chain.",-1),pt=t("h2",{id:"the-data-chain",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#the-data-chain"},"#"),e(" The Data Chain")],-1),gt=t("p",null,"Remember, each flow creates its own JSON object to store any data generated.",-1),ft=t("p",null,[e("When the flow begins, three keys are appended to the data chain: "),t("code",null,"$trigger"),e(", "),t("code",null,"$accountability"),e(", and "),t("code",null,"$last"),e(". Then, as each operation runs, it has access to this data chain. Once an operation finishes, its data is appended under its "),t("code",null,"<operationKey>"),e(". When the operation doesn\u2019t generate data, "),t("code",null,"null"),e(" is appended under its key.")],-1),wt=t("p",null,"The following is a highly generic example of a data chain.",-1),_t=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),e(`
+import{a as l,o as r,e as d,y as n,u as t,q as e,z as s}from"./runtime-core.esm-bundler.22ec0346.js";const u={class:"markdown-body"},h=t("blockquote",null,[t("p",null,"Flows enable custom, event-driven data processing and task automation within Directus. Each flow is composed of one trigger, followed by a series of operations.")],-1),p={class:"tip hint"},g=t("div",{class:"hint-title"},"Before You Begin",-1),f={class:"tip hint"},w=t("div",{class:"hint-title"},"Learn More",-1),_=t("h2",{id:"what%E2%80%99s-a-flow%3F",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#what%E2%80%99s-a-flow%3F"},"#"),e(" What\u2019s a Flow?")],-1),m=t("p",null,[t("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/flows/flows-20220603A/whats-a-flow-20220603A.webp",alt:"What's a Flow?"})],-1),y=t("p",null,"Each flow is made up of three elements: A trigger, operations, and a data chain.",-1),b=t("h3",{id:"triggers",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#triggers"},"#"),e(),t("strong",null,"Triggers")],-1),v=t("h3",{id:"operations",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#operations"},"#"),e(" Operations")],-1),j=t("em",null,"send off emails, push in-app notifications, send webhooks, and beyond",-1),k=t("p",null,"To put it in conceptual terms, operations do three things:",-1),x=t("ul",null,[t("li",null,[t("strong",null,"Get data"),e(" from Directus or another outside service.")]),t("li",null,[t("strong",null,"Process data"),e(" a.k.a. transform it, validate it, or whatever.")]),t("li",null,[t("strong",null,"Send data"),e(" to Directus or another outside service.")])],-1),T={class:"tip hint"},C=t("div",{class:"hint-title"},"Developers",-1),F=t("h3",{id:"data-chains",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#data-chains"},"#"),e(" Data Chains")],-1),A=t("p",null,[e("In order for a flow\u2019s operations to track and access the same data, each flow creates its own "),t("a",{href:"#the-data-chain"},"data chain"),e(". Every operation has access to this data chain and each operation appends some value onto this object after it runs. This means you can dynamically access data from a previous operation in the current operation with "),t("a",{href:"#data-chain-variables"},"data chain variables"),e(".")],-1),$=t("h3",{id:"control-flow",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#control-flow"},"#"),e(" Control Flow")],-1),D=t("em",null,"fails by design",-1),E=t("p",null,[e("These kinds of failed operations do not immediately stop your flow. Instead, flows let you implement "),t("a",{href:"https://en.wikipedia.org/wiki/Control_flow",target:"_blank",rel:"noopener noreferrer"},"control flow"),e(", by providing "),t("strong",null,"success paths"),e(" and "),t("strong",null,"failure paths"),e(" within a flow:")],-1),N=t("ul",null,[t("li",null,[t("strong",null,"Success"),e(" \u2014 If "),t("code",null,"operation1"),e(" executes successfully, then "),t("code",null,"operation2"),e(" executes.")]),t("li",null,[t("strong",null,"Failure"),e(" \u2014 Else if "),t("code",null,"operation1"),e(" fails on execution, then "),t("code",null,"operation3"),e(" executes.")])],-1),O=t("p",null,[t("em",null,"And there we have it!"),e(" These are the conceptual cornerstones of any flow. Now you\u2019ll need to know how to actually create a flow, which we discuss in the next section.")],-1),S=t("h2",{id:"configure-a-flow",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#configure-a-flow"},"#"),e(" Configure A Flow")],-1),I=t("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"Create a Flow"},[t("source",{src:"https://cdn.directus.io/docs/v9/configuration/flows/flows/flows-20220603A/create-a-flow-20220603A.mp4",type:"video/mp4"})],-1),L=t("h3",{id:"create-a-flow",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#create-a-flow"},"#"),e(" Create a Flow")],-1),Y=t("ol",null,[t("li",null,[e("Navigate to "),t("strong",null,"Settings > Flows"),e(" and click "),t("span",{mi:"",btn:""},"add"),e(" in the page header. A drawer will open.")]),t("li",null,[e("Under "),t("strong",null,"Flow Setup"),e(", fill in a "),t("strong",null,"Name"),e(" for the flow and the following "),t("em",null,"optional"),e(" details: "),t("ul",null,[t("li",null,[t("strong",null,"Status"),e(" \u2014 Sets the flow to active or inactive.")]),t("li",null,[t("strong",null,"Icon"),e(" \u2014 Adds an icon to help quickly identify the flow.")]),t("li",null,[t("strong",null,"Description"),e(" \u2014 Sets a brief verbal description of the flow.")]),t("li",null,[t("strong",null,"Color"),e(" \u2014 Sets a color to help identify the flow.")]),t("li",null,[t("strong",null,"Activity and Logs Tracking"),e(" \u2014 Lets you "),t("strong",null,"Track Activity and Logs"),e(", "),t("strong",null,"Activity"),e(", or "),t("strong",null,"Neither"),e(".")])])])],-1),K={class:"tip hint"},q=t("a",{href:"#logs"},"Logs",-1),R=t("h3",{id:"configure-a-trigger",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#configure-a-trigger"},"#"),e(" Configure a Trigger")],-1),P={start:"3"},W=t("span",{mi:"",btn:""},"arrow_forward",-1),B=t("strong",null,"Trigger Setup",-1),V=t("li",null,[e("Click "),t("span",{mi:"",btn:""},"done"),e(" in the menu header to confirm.")],-1),H=t("p",null,"You\u2019ll now see your trigger in an empty grid area. Its time to start adding operations.",-1),J=t("h3",{id:"configure-an-operation",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#configure-an-operation"},"#"),e(" Configure an Operation")],-1),z={start:"5"},G=t("li",null,[e("On the trigger panel, click "),t("span",{mi:""},"add"),e(" and the "),t("strong",null,"Create Operation"),e(" side drawer will open.")],-1),M=t("strong",null,"Name",-1),U=t("br",null,null,-1),Q=t("a",{href:"#the-data-chain"},"data chain",-1),X=t("br",null,null,-1),Z=t("li",null,[e("Next, click "),t("span",{mi:"",btn:""},"done"),e(" in the page header to confirm and return to the flow grid area.")],-1),tt=t("li",null,[e("From here, you can make the following optional configurations: "),t("ul",null,[t("li",null,[t("strong",null,"Reposition"),e(" \u2014 You can drag and drop panels to reposition as desired.")]),t("li",null,[t("strong",null,"Unlink/Relink"),e(" \u2014 Click and drag "),t("span",{mi:"",icon:"",prmry:""},"adjust"),e(" or "),t("span",{mi:"",icon:"",prmry:""},"arrow_forward"),e(" to unlink/relink flows.")]),t("li",null,[t("strong",null,"Duplicate an Operation"),e(" \u2014 To duplicate an operation, click "),t("span",{mi:"",icon:""},"more_vert"),e(" to open its context menu. Click "),t("span",{mi:"",icon:""},"control_point_duplicate"),e(" and a duplicate of the operation (and its configuration details) will be created.")]),t("li",null,[t("strong",null,"Copy an Operation"),e(" \u2014 To copy and paste an operation into another flow, click "),t("span",{mi:"",icon:""},"more_vert"),e(" to open its context menu. Click "),t("span",{mi:"",icon:""},"input"),e(" and a popup menu will open. Choose the desired flow from the dropdown and click "),t("strong",null,"Copy"),e(".")]),t("li",null,[t("strong",null,[t("span",{mi:"",icon:""},"data_object"),e(" Toggle Raw Editor")]),e(" \u2014 Click "),t("span",{mi:"",icon:""},"data_object"),e(" on an operations\u2019 form input fields to toggle the input type between standard and raw value. This is allows you to add a raw value or "),t("a",{href:"#data-chain-variables"},"Data Chain Variables"),e(" within any type of configuration option, even dropdown menus, checkboxes, and radio buttons.")]),t("li",null,[t("strong",null,"Delete an Operation"),e(" \u2014 To delete an operation, click "),t("span",{mi:"",icon:""},"more_vert"),e(" then "),t("span",{mi:"",icon:"",dngr:""},"delete"),e(". A popup menu will appear. Click "),t("strong",null,"Delete"),e(" to confirm.")])])],-1),et=t("li",null,[e("On the newly created operation panel: "),t("ul",null,[t("li",null,[e("Click "),t("span",{mi:"",icon:""},"add"),e(" to add an operation to the "),t("strong",null,"success path"),e(".")]),t("li",null,[e("Click "),t("span",{mi:"",icon:""},"remove"),e(" to add an operation to the "),t("strong",null,"failure path"),e(".")])])],-1),nt=t("li",null,"Repeat steps 5-10 to build out your flow as desired.",-1),ot=t("li",null,[e("Click "),t("span",{mi:"",btn:""},"done"),e(" to confirm and create your flow.")],-1),st=t("li",null,[e("Click "),t("span",{mi:"",btn:""},"arrow_back"),e(" to return to the flows list.")],-1),at=t("li",null,"Once created, you may need to re-edit your flow, toggle it to inactive, or delete it.",-1),lt=t("h3",{id:"edit-a-flow",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#edit-a-flow"},"#"),e(" Edit a Flow")],-1),it=t("ol",null,[t("li",null,"Navigate to the desired flow."),t("li",null,[e("Click "),t("span",{mi:"",btn:"",muted:""},"edit"),e(" in the flow page header and make reconfigurations as desired.")]),t("li",null,[e("Click "),t("span",{mi:"",btn:""},"done"),e(" to confirm.")])],-1),ct=t("h3",{id:"toggle-a-flow-to-inactive",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#toggle-a-flow-to-inactive"},"#"),e(" Toggle a Flow to Inactive")],-1),rt=t("ol",null,[t("li",null,[e("Navigate to "),t("strong",null,"Settings > Flows"),e(" and click "),t("span",{mi:"",icon:""},"more_vert"),e(" on the desired flow.")]),t("li",null,[e("Click "),t("strong",null,[t("span",{mi:"",icon:""},"check"),e(" Set Flow to Active")]),e(" or "),t("strong",null,[t("span",{mi:"",icon:""},"block"),e(" Set Flow to Inactive")]),e(".")])],-1),dt=t("h3",{id:"delete-a-flow",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#delete-a-flow"},"#"),e(" Delete a Flow")],-1),ut=t("ol",null,[t("li",null,[e("Click "),t("span",{mi:"",icon:""},"more_vert"),e(" on the desired flow to open its context menu.")]),t("li",null,[e("Click "),t("span",{mi:"",icon:"",dngr:""},"delete"),e(" and a popup menu will appear. Click "),t("strong",null,"Delete"),e(" to confirm.")])],-1),ht=t("p",null,"Now that we know how to create and configure a flow, it\u2019s time to get a firmer understanding of the data chain.",-1),pt=t("h2",{id:"the-data-chain",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#the-data-chain"},"#"),e(" The Data Chain")],-1),gt=t("p",null,"Remember, each flow creates its own JSON object to store any data generated.",-1),ft=t("p",null,[e("When the flow begins, three keys are appended to the data chain: "),t("code",null,"$trigger"),e(", "),t("code",null,"$accountability"),e(", and "),t("code",null,"$last"),e(". Then, as each operation runs, it has access to this data chain. Once an operation finishes, its data is appended under its "),t("code",null,"<operationKey>"),e(". When the operation doesn\u2019t generate data, "),t("code",null,"null"),e(" is appended under its key.")],-1),wt=t("p",null,"The following is a highly generic example of a data chain.",-1),_t=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),e(`
 	`),t("span",{class:"hljs-attr"},'"$trigger"'),t("span",{class:"hljs-punctuation"},":"),e(),t("span",{class:"hljs-punctuation"},"{"),e(`
 		`),t("span",{class:"hljs-comment"},"// Contains data generated by the flow's trigger."),e(`
 		`),t("span",{class:"hljs-comment"},"// This could include headers, access tokens, payloads, etc."),e(`
@@ -43,4 +43,4 @@ import{a as l,o as r,b as d,w as n,l as t,E as e,e as s}from"./runtime-core.esm-
 `)])],-1),Dt={class:"tip hint"},Et=t("p",null,[e("Certain operations use dropdowns, toggles, checkboxes, and other input options. However, you can bypass this entirely to input raw values directly with "),t("a",{href:"#configure-an-operation"},"Toggle to Raw Editor"),e(". You can use double-moustache syntax to access data dynamically in these input options as well.")],-1),Nt=t("h2",{id:"logs",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#logs"},"#"),e(" Logs")],-1),Ot=t("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:""},[t("source",{src:"https://cdn.directus.io/docs/v9/configuration/flows/flows/flows-20220603A/logs-20220603A.mp4",type:"video/mp4"})],-1),St=t("p",null,"Accessible from the sidebar, logs store information for each flow execution. Each log will display information from triggers as well as each operation in the flow. To access a flow\u2019s logs, follow these steps.",-1),It=t("ol",null,[t("li",null,[e("Navigate to "),t("strong",null,"Settings > Flows"),e(" and click the desired flow.")]),t("li",null,[e("Click "),t("strong",null,[t("span",{mi:"",icon:"",prmry:""},"fact_check"),e(" Logs")]),e(" in the sidebar. A side drawer will open, displaying the flow\u2019s logs.")]),t("li",null,"Click a log and another side drawer will open, allowing you to peer through its data."),t("li",null,[e("When finished, click "),t("span",{mi:"",btn:"",muted:""},"close"),e(" to close the drawer.")])],-1),Lt=t("p",null,"Logs are not a 1:1 mapping to the data chain. Each trigger and operation gets its own dropdown, which stores its relevant data. Here\u2019s what you\u2019ll get from each of these:",-1),Yt=t("p",null,[t("strong",null,"Trigger")],-1),Kt=t("ul",null,[t("li",null,[t("strong",null,"Options"),e(" \u2014 The values you input when you configured the trigger."),t("br"),t("em",null,"(These configuration options are not stored on the data chain)"),e(".")]),t("li",null,[t("strong",null,"Payload"),e(" \u2014 Displays the data appended under "),t("code",null,"$trigger"),e(".")]),t("li",null,[t("strong",null,"Accountability"),e(" \u2014 Displays data appended under "),t("code",null,"$accountability"),e(".")])],-1),qt=t("p",null,[e("Note that "),t("code",null,"$accountability"),e(" is not nested under the "),t("code",null,"$trigger"),e(" key. However, it is listed under the Trigger in the Log because "),t("code",null,"$accountability"),e(" is generated by the trigger.")],-1),Rt=t("p",null,[t("strong",null,[t("code",null,"<OperationKey>")])],-1),Pt=t("ul",null,[t("li",null,[t("strong",null,"Options"),e(" \u2014 The values you input when you configured the operation."),t("br"),t("em",null,"(These configuration options are not stored on the data chain)"),e(".")]),t("li",null,[t("strong",null,"Payload"),e(" \u2014 Displays the data appended under this "),t("code",null,"<operationKey>"),e(".")])],-1),Wt=t("strong",null,"Options",-1),Bt=t("code",null,"message",-1),Vt=t("code",null,'"The last operation was a success"',-1),Ht=t("pre",null,[t("code",null,`{
 	"message": "The last operation was a success"
 }
-`)],-1),Jt=t("div",{class:"warning hint"},[t("div",{class:"hint-title"},"Logs are stored in the database"),t("p",null,"Keep in mind that if you\u2019ve configured a flow to track logs, all this information is stored in the database. You may need to periodically delete this data.")],-1),Gt=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Where is `$last`?"),t("p",null,[e("You may notice "),t("code",null,"$last"),e(" is not in the Logs. Remember, "),t("code",null,"$last"),e(" constantly updates to store the data of the most recently executed operation. The log shows the results of the entire flow. Therefore "),t("code",null,"$last"),e(" would simply be the very last operation in the flow.")])],-1),Mt=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"More on Debugging"),t("p",null,[e("You may find a tool like "),t("a",{href:"https://www.postman.com/",target:"_blank",rel:"noopener noreferrer"},"Postman"),e(" quite helpful for viewing data and debugging flows.")])],-1),Zt="Flows",te=!1,ee="Flows enable custom, event-driven data processing and task automation within Directus. Each flow is composed of one trigger, followed by a series of operations.",ne="5 min read",oe={__name:"flows",setup(Ut,{expose:i}){const a={title:"Flows",modularExtension:!1,description:"Flows enable custom, event-driven data processing and task automation within Directus. Each flow is composed of one trigger, followed by a series of operations.",readTime:"5 min read"};return i({frontmatter:a}),(zt,Qt)=>{const o=l("router-link"),c=l("docs-wrapper");return r(),d(c,{frontmatter:a},{default:n(()=>[t("div",u,[h,t("div",p,[g,t("p",null,[e("Please be sure to see the "),s(o,{to:"/docs/getting-started/quickstart.md"},{default:n(()=>[e("Quickstart Guide")]),_:1}),e(" to get a basic overview of the platform.")])]),t("div",f,[w,t("p",null,[e("There is also dedicated API documentation on "),s(o,{to:"/docs/reference/system/flows"},{default:n(()=>[e("Flows")]),_:1}),e(" and "),s(o,{to:"/docs/reference/system/operations"},{default:n(()=>[e("Operations")]),_:1}),e(".")])]),_,m,y,b,t("p",null,[e("Each flow begins with a "),s(o,{to:"/docs/configuration/flows/triggers"},{default:n(()=>[e("trigger")]),_:1}),e(", which defines the action or event that starts the Flow. This action or event could be some type of transaction within the app, an incoming webhook, a cron job, etc.")]),v,t("p",null,[e("An "),s(o,{to:"/docs/configuration/flows/operations"},{default:n(()=>[e("operation")]),_:1}),e(" is an action or process performed within the flow. These enable you to manage data: "),j,e(".")]),k,x,t("div",T,[C,t("p",null,[e("You can even develop your own "),s(o,{to:"/docs/extensions/operations.md"},{default:n(()=>[e("custom operations")]),_:1}),e(" to fit any use-case.")])]),F,A,$,t("p",null,[e("Not every operation that executes in a flow does so successfully. In some cases, your operations are going to fail. Perhaps an operation tried to access data that doesn\u2019t exist, or a webhook operation fails for some reason, or perhaps you set a "),s(o,{to:"/docs/configuration/flows/operations.md#condition"},{default:n(()=>[e("condition")]),_:1}),e(" operation, which "),D,e(" when its condition is not met.")]),E,N,O,S,I,L,Y,t("div",K,[t("p",null,[e("To learn more, see the section below on "),q,e(" as well as the "),s(o,{to:"/docs/configuration/activity-log.html"},{default:n(()=>[e("Activity Log")]),_:1}),e(" documentation.")])]),R,t("ol",P,[t("li",null,[e("Click "),W,e(" to navigate to "),B,e(". Select a "),s(o,{to:"/docs/configuration/flows/triggers"},{default:n(()=>[e("trigger")]),_:1}),e(" type and configure as desired.")]),V]),H,J,t("ol",G,[M,t("li",null,[e("Choose a "),U,e(", an "),s(o,{to:"/docs/configuration/flows/operations"},{default:n(()=>[e("operation")]),_:1}),e(" type, and configure as desired."),z,e(" Directus will convert the name into a unique operation key, used on the "),Q,e("."),X,e(" If you don\u2019t choose a name, the system will auto-generate a name and key for you.")]),Z,tt,et,nt,ot,st,at]),lt,it,ct,rt,dt,ut,ht,pt,gt,ft,wt,_t,mt,yt,bt,vt,jt,kt,xt,Tt,Ct,Ft,At,$t,t("div",Dt,[t("p",null,[e("To perform computations on flow data, use the "),s(o,{to:"/docs/configuration/flows/operations.md#script"},{default:n(()=>[e("script operation")]),_:1}),e(" or a "),s(o,{to:"/docs/configuration/flows/operations.md#webhook"},{default:n(()=>[e("webhook")]),_:1}),e(".")])]),Et,Nt,Ot,St,It,Lt,Yt,Kt,qt,Rt,Pt,t("p",null,[e("Remember, the "),s(o,{to:"/docs/configuration/flows/operations.md#log-to-console"},{default:n(()=>[e("Log to Console")]),_:1}),e(" operation is a key debugging tool. It does not append data to the data chain. You will view your log message under "),Wt,e(". Therefore, anything you log will always be displayed as nested under a "),Bt,e(" key. For example, if you decide to log "),Vt,e(", it will be displayed as:")]),Ht,Jt,Gt,Mt])]),_:1})}}};export{oe as default,ee as description,te as modularExtension,ne as readTime,Zt as title};
+`)],-1),Jt=t("div",{class:"warning hint"},[t("div",{class:"hint-title"},"Logs are stored in the database"),t("p",null,"Keep in mind that if you\u2019ve configured a flow to track logs, all this information is stored in the database. You may need to periodically delete this data.")],-1),zt=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Where is `$last`?"),t("p",null,[e("You may notice "),t("code",null,"$last"),e(" is not in the Logs. Remember, "),t("code",null,"$last"),e(" constantly updates to store the data of the most recently executed operation. The log shows the results of the entire flow. Therefore "),t("code",null,"$last"),e(" would simply be the very last operation in the flow.")])],-1),Gt=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"More on Debugging"),t("p",null,[e("You may find a tool like "),t("a",{href:"https://www.postman.com/",target:"_blank",rel:"noopener noreferrer"},"Postman"),e(" quite helpful for viewing data and debugging flows.")])],-1),Zt="Flows",te=!1,ee="Flows enable custom, event-driven data processing and task automation within Directus. Each flow is composed of one trigger, followed by a series of operations.",ne="5 min read",oe={__name:"flows",setup(Mt,{expose:i}){const a={title:"Flows",modularExtension:!1,description:"Flows enable custom, event-driven data processing and task automation within Directus. Each flow is composed of one trigger, followed by a series of operations.",readTime:"5 min read"};return i({frontmatter:a}),(Ut,Qt)=>{const o=l("router-link"),c=l("docs-wrapper");return r(),d(c,{frontmatter:a},{default:n(()=>[t("div",u,[h,t("div",p,[g,t("p",null,[e("Please be sure to see the "),s(o,{to:"/docs/getting-started/quickstart.md"},{default:n(()=>[e("Quickstart Guide")]),_:1}),e(" to get a basic overview of the platform.")])]),t("div",f,[w,t("p",null,[e("There is also dedicated API documentation on "),s(o,{to:"/docs/reference/system/flows"},{default:n(()=>[e("Flows")]),_:1}),e(" and "),s(o,{to:"/docs/reference/system/operations"},{default:n(()=>[e("Operations")]),_:1}),e(".")])]),_,m,y,b,t("p",null,[e("Each flow begins with a "),s(o,{to:"/docs/configuration/flows/triggers"},{default:n(()=>[e("trigger")]),_:1}),e(", which defines the action or event that starts the Flow. This action or event could be some type of transaction within the app, an incoming webhook, a cron job, etc.")]),v,t("p",null,[e("An "),s(o,{to:"/docs/configuration/flows/operations"},{default:n(()=>[e("operation")]),_:1}),e(" is an action or process performed within the flow. These enable you to manage data: "),j,e(".")]),k,x,t("div",T,[C,t("p",null,[e("You can even develop your own "),s(o,{to:"/docs/extensions/operations.md"},{default:n(()=>[e("custom operations")]),_:1}),e(" to fit any use-case.")])]),F,A,$,t("p",null,[e("Not every operation that executes in a flow does so successfully. In some cases, your operations are going to fail. Perhaps an operation tried to access data that doesn\u2019t exist, or a webhook operation fails for some reason, or perhaps you set a "),s(o,{to:"/docs/configuration/flows/operations.md#condition"},{default:n(()=>[e("condition")]),_:1}),e(" operation, which "),D,e(" when its condition is not met.")]),E,N,O,S,I,L,Y,t("div",K,[t("p",null,[e("To learn more, see the section below on "),q,e(" as well as the "),s(o,{to:"/docs/configuration/activity-log.html"},{default:n(()=>[e("Activity Log")]),_:1}),e(" documentation.")])]),R,t("ol",P,[t("li",null,[e("Click "),W,e(" to navigate to "),B,e(". Select a "),s(o,{to:"/docs/configuration/flows/triggers"},{default:n(()=>[e("trigger")]),_:1}),e(" type and configure as desired.")]),V]),H,J,t("ol",z,[G,t("li",null,[e("Choose a "),M,e(", an "),s(o,{to:"/docs/configuration/flows/operations"},{default:n(()=>[e("operation")]),_:1}),e(" type, and configure as desired."),U,e(" Directus will convert the name into a unique operation key, used on the "),Q,e("."),X,e(" If you don\u2019t choose a name, the system will auto-generate a name and key for you.")]),Z,tt,et,nt,ot,st,at]),lt,it,ct,rt,dt,ut,ht,pt,gt,ft,wt,_t,mt,yt,bt,vt,jt,kt,xt,Tt,Ct,Ft,At,$t,t("div",Dt,[t("p",null,[e("To perform computations on flow data, use the "),s(o,{to:"/docs/configuration/flows/operations.md#script"},{default:n(()=>[e("script operation")]),_:1}),e(" or a "),s(o,{to:"/docs/configuration/flows/operations.md#webhook"},{default:n(()=>[e("webhook")]),_:1}),e(".")])]),Et,Nt,Ot,St,It,Lt,Yt,Kt,qt,Rt,Pt,t("p",null,[e("Remember, the "),s(o,{to:"/docs/configuration/flows/operations.md#log-to-console"},{default:n(()=>[e("Log to Console")]),_:1}),e(" operation is a key debugging tool. It does not append data to the data chain. You will view your log message under "),Wt,e(". Therefore, anything you log will always be displayed as nested under a "),Bt,e(" key. For example, if you decide to log "),Vt,e(", it will be displayed as:")]),Ht,Jt,zt,Gt])]),_:1})}}};export{oe as default,ee as description,te as modularExtension,ne as readTime,Zt as title};