Pubblicare un notebook come strumento web

ArcGIS Notebooks consente di pubblicare i notebook come strumenti Web. Gli amministratori e gli autori di notebook con il privilegio di pubblicazione di strumenti Web possono pubblicare i notebook che possiedono come strumenti Web. Quando un notebook viene pubblicato come strumento Web, un servizio di geoprocessing asincrono viene creato sul sito ArcGIS Notebook Server e registrato come strumento Web. C'è una relazione uno-a-uno tra il notebook e lo strumento web, il che significa che solo uno strumento web può essere pubblicato per ogni notebook, e all'elemento dello strumento web sono assegnate le stesse autorizzazioni di condivisione del notebook padre. Gli strumenti web possono essere consumati da qualsiasi applicazione client che può lavorare con servizi di geoprocessing asincrono RESTful.

La pubblicazione di un notebook come strumento Web è supportata per notebook con runtime versione 6.0 o successiva. Per controllare le informazioni sul runtime di un notebook, fai clic sul pulsante Info nella barra multifunzione superiore dell'editor del notebook o nella scheda Impostazioni nella pagina Elemento notebook. Per saperne di più sui runtime dei notebook, consultareVisualizzare le librerie Python disponibili.

L'editor di notebook consente di configurare i parametri di input e output per un notebook. I parametri di input corrispondono alle variabili di input in un notebook che si desidera esternalizzare per l'input dell'utente quando il notebook viene eseguito come strumento web. I parametri di output rappresentano le variabili di output in un notebook che si desidera restituire come output dello strumento web. Quando registri una o più variabili di input o output e pubblichi un notebook, i parametri diventano disponibili come parametri di input o output per lo strumento web corrispondente.

Nota:

Non è necessario definire parametri di input o output quando si pubblica un notebook come strumento web. Per esempio, i notebook che eseguono compiti con input e output predefiniti, come i feature layer a cui itemId fa riferimento, possono non richiedere parametri di input o output.

Nota:

I seguenti tipi di dati sono supportati come parametri di input o output: Stringa, Long, Double, Booleano, Set di feature, Set di record, Dati raster, Data o Unità lineare. Per ulteriori informazioni, vedi Tipi di dati di servizi di geoprocessing nella documentazione dell'API REST di ArcGIS Notebook Server.

Quando è in esecuzione uno strumento Web, ArcGIS Notebook Server effettua un'esecuzione automatizzata del notebook nella macchina server del notebook aprendo un nuovo contenitore ed eseguendo il notebook senza interazione con l'utente. Gli utenti con privilegi di esecuzione di strumenti Web e con cui è stato condiviso il notebook possono accedere allo strumento Web ed eseguirlo. Oltre al privilegio richiesto per l'esecuzione di strumenti Web, sono necessari altri privilegi necessari per l'esecuzione del notebook. Per ulteriori informazioni sui privilegi, consultare l'argomento Tipi di utente, ruoli e privilegi.

Nota:

Quando si crea un notebook da condividere come strumento Web, se il blocco note fa riferimento a un file della directory dell'area di lavoro come dati di input, tali file non saranno accessibili ad altri con cui il blocco note o lo strumento Web sono condivisi. Se hai dei file che devono essere referenziati come dati di input nel notebook, puoi fare riferimento al file attraverso un elemento del portale condiviso in Portal for ArcGIS o caricare e referenziare il file da una directory di dati personalizzata registrata con ArcGIS Notebook Server.

Per impostazione predefinita, ArcGIS Notebook Server è configurato per eseguire un massimo di 10 esecuzioni simultanee e non interattive di notebook per ogni ArcGIS Notebook Server macchina. Questo include le esecuzioni attivate da strumenti web, attività pianificate, l'API executeNotebook e i trigger webhook. Gli amministratori possono aumentare questo limite, se necessario.

Nota:

Se non sono visibili le opzioni Parametri o Pubblica nell'editor del notebook, non si dispone del privilegio di pubblicare strumenti Web o non si è il proprietario del notebook. Se sei in un blocco note appena creato, le opzioni Parametri e Pubblica non vengono visualizzate finché il notebook non è stato salvato.

Configurare i parametri di ingresso

I parametri di input rappresentano le variabili di input di un notebook che vengono esternalizzate quando il notebook viene eseguito come strumento web. Usando il pannello Parametri nell'editor del blocco note, puoi configurare e aggiungere parametri di input come variabili al notebook.

1. Nell'editor del notebook, clicca su Parametri.
2. Fare clic su Aggiungi.
3. Selezionare input per Direzione.
4. Inserisci un nome per il Nome della variabile.

   Nota:

   Questo deve corrispondere a un nome di variabile che si trova nel codice del notebook o che è già configurato nel notebook.

5. Inserisci un nome per Nome visualizzato per il parametro dello strumento web.
6. Dal menu a discesa Tipo di dati, seleziona un tipo di dati per il parametro di ingresso.
7. Inserire un valore per Valore predefinito per il parametro di input. Fare riferimento a Tipi di dati dei servizi di geoprocessing per la sintassi dei valori predefiniti per i tipi di dati supportati.
8. Per Descrizione, inserire una descrizione per il parametro di input.
9. Fare clic su Salva per salvare il parametro inserito.
10. Per aggiungere altri parametri di input, ripeti i punti da 1 a 9.
11. Dopo aver aggiunto tutti i tuoi parametri di input, seleziona una cella nel tuo notebook per i parametri da inserire e clicca su Inserisci come variabili.
12. Clicca su Salva per salvare il notebook.

Configura i parametri di uscita

Puoi configurare l'output per un notebook pubblicato come strumento Web configurando parametri di input dal riquadro Parametri nell'editor del notebook.

1. Nell'editor del notebook, clicca su Parametri.
2. Fare clic su Aggiungi.
3. Selezionare l'output per il parametro Direzione.
4. Inserisci un nome per il Nome della variabile.

   Nota:

   Questo deve corrispondere a un nome di variabile che si trova nel codice del notebook o che è già configurato nel notebook.

5. Inserisci un nome per Nome visualizzato per il parametro dello strumento web.
6. Dal menu a discesa Tipo di dati, selezionare un tipo di dati per il parametro di output.
7. Inserire un valore per Valore predefinito per il parametro di output. Fare riferimento a Tipi di dati dei servizi di geoprocessing per la sintassi dei valori predefiniti per i tipi di dati supportati.
8. Per Descrizione, digitare una descrizione per il parametro di uscita.
9. Clicca su Salva per salvare il parametro di uscita.
10. Seleziona una cella del tuo notebook.a Fare clic sul pulsante Aggiungi per aggiungere il frammento di codice Python per scrivere l'output per lo strumento Web.

    Si raccomanda di selezionare una cella vicino al fondo del notebook, sotto le celle dove vengono create le uscite.

11. Ispeziona lo snippet di codice aggiunto per assicurarti che i nomi delle variabili di output corrispondano all'output definito nel notebook, e fai qualsiasi ulteriore aggiustamento allo snippet di codice.
12. Ripetere i passi da 1 a 11 per qualsiasi altro parametro di uscita.
13. Clicca su Salva per salvare il notebook.

Pubblica uno strumento web

Puoi pubblicare un blocco note come strumento web dal pannello Pubblica nell'editor di blocco note.

1. Salva il tuo notebook per assicurarti che l'ultima copia del notebook sia pubblicata.
2. Esegui manualmente le celle del notebook in modo interattivo per assicurarti che non ci siano errori.

Nota:

Salta le celle che contengono gli snippet di codice per i parametri di output, poiché non vengono eseguiti in modalità interattiva.
3. Fai clic su Pubblica sulla barra multifunzione dell'editor del blocco note.
4. Inserire un titolo e una descrizione per lo strumento Web nei campi Titolo e Descrizione nel pannello Pubblica.
5. Controlla tutti i parametri di ingresso e di uscita.
6. Fai clic su Pubblica per pubblicare il blocco note come strumento web.
7. Dopo la corretta pubblicazione dello strumento Web, fai clic su Visualizza dettagli per visualizzare la pagina dei dettagli dell'elemento per lo strumento Web.
8. Fai clic su Condividi per aprire la finestra di condivisione.
   1. Seleziona Organizzazione per condividere lo strumento Web con tutti gli utenti nell'organizzazione.
   2. Fai clic su Modifica condivisione gruppo per condividere lo strumento Web con gruppi specifici.
   3. Seleziona i gruppi con cui condividere.
   4. Fare clic su Ok.
   5. Fare clic su Salva.

Condividere uno strumento Web

Per condividere o aggiornare le impostazioni di condivisione per uno strumento Web di un notebook esistente con l'organizzazione o gruppi specifici nell'organizzazione, effettua la procedura seguente.

Nota:

Per poter eseguire lo strumento Web condiviso, gli utenti con cui è condiviso lo strumento Web devono disporre dei privilegi di esecuzione di strumenti Web e di eventuali privilegi aggiuntivi necessari per l'esecuzione del notebook.

Nota:

A partire dalla versione 11.2, è possibile condividere uno strumento Web di notebook a un livello diverso da quello in cui è stato pubblicato il notebook. Ad esempio, uno strumento Web di notebook può essere condiviso con l'organizzazione anche se il notebook stesso non è condiviso con l'organizzazione. Per assicurarsi che uno strumento Web pubblicato in una release precedente possa utilizzare questa modifica, sovrascrivi lo strumento Web.

1. Accertati di aver eseguito l'accesso a Portal for ArcGIS e di disporre di privilegi sufficienti per la condivisione del contenuto con l'organizzazione.
2. Fare clic su Contenuti.
3. Seleziona la casella accanto al titolo dello strumento Web da condividere.
4. Fare clic su Condividi.
   1. Seleziona Organizzazione per condividere lo strumento Web con tutti gli utenti nell'organizzazione.
   2. Fai clic su Modifica condivisione gruppo per condividere lo strumento Web con gruppi specifici.
   3. Seleziona i gruppi con cui condividere.
   4. Fare clic su Ok.
   5. Fare clic su Salva.

Sovrascrivere uno strumento web

La sovrascrittura di uno strumento web aggiornerà uno strumento web per utilizzare l'ultima istantanea di quel notebook. È possibile sovrascrivere uno strumento Web del notebook nel riquadro Pubblica dell'editor del notebook.

1. Se è necessario aggiornare un parametro di ingresso o di uscita esistente, seguire la procedura descritta nella sezione Modifica di un parametro di ingresso o di uscita esistente di questo argomento.
2. Se si stanno aggiungendo nuovi parametri di ingresso o di uscita, seguire i passaggi indicati nelle sezioni Configurazione dei parametri di ingresso o Configurazione dei parametri di uscita di questo argomento.
3. Fare clic su Salva per assicurarsi che venga pubblicata l'ultima copia del notebook.
4. Eseguire manualmente ogni cella del notebook per verificare che non vi siano errori.

   Nota:

   Non eseguire le celle che contengono gli snippet di codice per i parametri di output, poiché non verranno eseguite in modalità interattiva.

5. Fare clic su Pubblica.
6. Fare clic su Sovrascrivi per sovrascrivere lo strumento web.

Elimina uno strumento web

Puoi cancellare un servizio di geoprocessing pubblicato da un blocco note cancellando l'elemento dello strumento web.

1. Sulla barra multifunzione superiore dell'editor del blocco note, fai clic su Pubblica.
2. Fai clic su Visualizza dettagli per visualizzare la pagina dei dettagli dell'elemento per lo strumento Web.
3. Fare clic su Impostazioni.
4. Fai clic su Elimina elemento e conferma che vuoi rimuovere l'elemento strumento web e il servizio di geoprocessing pubblicato su ArcGIS Notebook Server.

Modifica un parametro di ingresso o di uscita esistente

È possibile apportare modifiche a un parametro di ingresso o di uscita esistente dal pannello Parametri nell'editor del blocco note.

Nota:

Se un notebook è già stato pubblicato come strumento Web, è necessario attivare il pulsante Attiva modifica nel pannello Parametri prima di poter apportare modifiche ai parametri. Sii cauto nell'apportare modifiche ai tuoi parametri dopo che il blocco note è stato pubblicato come strumento web, poiché queste modifiche possono potenzialmente rompere qualsiasi applicazione web che utilizza lo strumento web.

1. Sulla barra multifunzione superiore dell'editor del blocco note, fai clic su Parametri.
2. Fai clic sul pulsante delle opzioni accanto al parametro e clicca su Modifica.
3. Aggiorna il parametro e clicca su Salva.
   1. Se un parametro di input è stato aggiornato, cancella o rimuovi manualmente la cella esistente con le variabili di input e ripeti il passo per inserire i parametri di input come variabili nel notebook.
   2. Se un parametro di uscita è stato aggiornato, cancella manualmente lo snippet di codice corrispondente alla variabile di uscita e ripeti i passi per aggiungere lo snippet di codice per il parametro di uscita al notebook.
4. Clicca su Salva per salvare il notebook.

Cancella un parametro di ingresso o di uscita esistente

Puoi cancellare i parametri di input o output esistenti dal pannello Parametri.

1. Sulla barra multifunzione superiore dell'editor del blocco note, fai clic su Parametri.
2. Fai clic sul pulsante delle opzioni accanto al parametro e clicca su Elimina.
3. Clicca su delete per rimuovere definitivamente il parametro.
4. Annulla o rimuovi manualmente la variabile di input o lo snippet di codice di output nel notebook.
5. Clicca su Salva per salvare il notebook.

Utilizzare l'estensione mappa

Quando si esegue uno strumento Web in Map Viewer classico, l'estensione mappa viene comunicata al notebook come variabile Python denominata context, insieme ad altri parametri di input, come indicato di seguito.

context = {
    "extent": {
        "ymin": -25203428.462408017,
        "xmin": -46101923.491795965,
        "ymax": 25203428.462407943,
        "xmax": 46101923.491795965,
        "spatialReference": {
            "wkt": "PROJCS[\"WGS_1984_Web_Mercator_Auxiliary_Sphere\",GEOGCS[\"GCS_WGS_1984\",DATUM[\"D_WGS_1984\",SPHEROID[\"WGS_1984\",6378137.0,298.257223563]],PRIMEM[\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],PROJECTION[\"Mercator_Auxiliary_Sphere\"],PARAMETER[\"False_Easting\",0.0],PARAMETER[\"False_Northing\",0.0],PARAMETER[\"Central_Meridian\",0],PARAMETER[\"Standard_Parallel_1\",0.0],PARAMETER[\"Auxiliary_Sphere_Type\",0.0],UNIT[\"Meter\",1.0]]"
        },
    }
}

È possibile utilizzare il valore della variabile context per impostare l'estensione dei flussi di lavoro di analisi spaziale nel notebook. Per testare i flussi di lavoro di analisi spaziale con un'estensione mappa prima di pubblicare il notebook come strumento Web, dichiarare la variabile context con un valore predefinito.

Quando di è pronti a pubblicare, inserire i parametri di input come variabili dopo la cella in cui è dichiarata la variabile context.

Risoluzione dei problemi di esecuzione di uno strumento web

Dopo aver pubblicato un notebook come strumento Web, è possibile verificare se lo strumento Web viene eseguito correttamente eseguendo il task dalla directory dei servizi ArcGIS Notebook Server.

1. In un browser web, aprire la directory ArcGIS Notebook Server dei servizi https://notebookserver.domain.com/webadaptorcontext/rest/services.
2. Accedi come proprietario dello strumento web.
3. Identifica il servizio e vai alla pagina dei compiti.
4. Fare clic su Invia lavoro.
5. Inserisci qualsiasi parametro di input e clicca su Invia lavoro.
6. Facoltativamente, clicca sul collegamento Controlla di nuovo i dettagli del lavoro per controllare lo stato del lavoro.

   Se lo strumento web si completa con successo, vengono forniti i link agli output. Un'anteprima HTML dell'esecuzione del blocco note è fornita come output di default, sia per le esecuzioni riuscite che per quelle fallite.

7. Scaricare e visualizzare l'anteprima HTML del notebook per verificare se ci sono stati problemi con l'esecuzione dello strumento web.
8. Se lo strumento web non riesce, conferma che il notebook viene eseguito con successo nell'editor di notebook.