namedQuery

Syntax

app.namedQuery(queryName);

Parameters

queryName string

The name of the query (case insensitive).

Return value string

A comma-separated string representing the query result, in the same format as storedUserQuery() and browseQuery(): a Columns: header section followed by Rows: data, and First Entry:, Listed Entries:, and Total Entries: counters.

Description

The namedQuery() function performs a named query. It can be used for the standard Inbox, Libraries and Templates queries. The namedQuery() function can also be used for any other custom Named Query created on the Named Queries page of Studio Server.

Method Query definition Filters
namedQuery(queryName) Defined by an administrator on the Named Queries page of Studio Server (server-side, shared) Fixed criteria as configured on the server; includes built-ins such as inbox, libraries, and templates
storedUserQuery(queryName) Saved by the user through the Smart Connection panel UI (client-side, per user) Brand, Issue, Edition, Section, State, plus any additional search criteria saved with the query
browseQuery(brand, issue, section, state) No stored definition — all filters are passed inline as parameters Brand, Issue, Section, and State only

Use namedQuery() for shared, server-managed queries that apply consistently across all users. Use storedUserQuery() to re-execute a query a user has saved in their Smart Connection panel. Use browseQuery() when you want to pass filter criteria directly from the script.

Examples

Get the results for namedQuery

var queryResults = app.namedQuery("inbox"); // or
queryResults = app.namedQuery("lIbraRies"); // or
queryResults = app.namedQuery("templates");

// Example of queryResults:
//
// "Columns: <int, ID><string, Name><string, Type><string, In Use By>
//    <int, Rating><multilist, Issues><list, Status><string, Status ID>
//    <int, Flag><list, Category><string, Category><double, Width>
//    <double, Height><string, Created By><string, Aspect ratio>
//    <string, Urgency><datetime, Created On><multiline, Description>
//    <string, Copyright (c)><int, Size><datetime, Modified On>
//    <string, Modified By><string, Author><list, Route To>
//    <string, Placed On><list, Brand><string, Brand ID>
//    <string, Planned Page Range><string, Page Range><string, FlagMsg>
//    <icon, Deadline><datetime, Deadline><string, Placed On Page>
//    <multiline, Comment><string, Color Space><int, Columns>
//    <string, Issue ID><string, Format><bool, LockForOffline>
//    <multilist, Issue IDs><multilist, Edition IDs><bool, HasChildren>
//
// Rows:
//  <6315, test-layout, Article, , , 1st Issue, Ready, 2, ,
//  News, 1, 523.275591, 769.889764, Joe, , , 06/12/2018 09:07, , ,
//  56 KB, 06/12/2018 09:10, Joe, , , L-testupdate1, WW News, 1, , , ,
//  0;cdcdcd, , 1, , , 1, , application/incopyicml, false, 1, 1, 2, false>
//
//  <1921, AWinttroart1, Article, , , 1st Issue, Ready, 2, ,
//  News, 1, 164, 175, Joe, , , 03/01/2018 14:54, , , 56 KB,
//  03/01/2018 15:05, Joe, , Joe, LWinttroart1, WW News, 1, , , ,
//  0;cdcdcd, , 1, , , 3, , application/incopyicml, false, 1, 1, 2, false>
//
//  <1922, Art2, Article, , , 1st Issue, Ready, 2, , News, 1,
//  523.275591, 769.889764, Joe, , , 03/01/2018 14:59, , , 50 KB,
//  03/01/2018 15:01, Joe, , , LWinttroart1, WW News, 1, , , , 0;cdcdcd,
//   , 1, , , 1, , application/incopyicml, false, 1, 1, 2, false>
//
//
//  First Entry: 1
//
//  Listed Entries: 3
//
//  Total Entries: 3"

Choose between namedQuery, storedUserQuery, and browseQuery

// Use namedQuery() for a shared, server-defined query (e.g. the user's Inbox).
var inboxResult = app.namedQuery("inbox");

// Use storedUserQuery() to re-run a query the user saved in the panel,
// without hardcoding its filter values in the script.
var savedResult = app.storedUserQuery("Q4 Campaign Assets");

// Use browseQuery() when you know the exact filter values at script time.
var browseResult = app.browseQuery("WW News", "1st Issue", "News", "Ready");

Supported versions

Adobe Version Supported
2023 ✔
2024 ✔
2025 ✔
2026 ✔