Argomento precedente: createDocument

Argomento successivo: deleteDocument

modifyDocument

I parametri seguenti sono validi per il metodo modifyDocument:

Parametro

Tipo

Descrizione

SID

Numero intero

Identifica la sessione recuperata dall'accesso.

docId

Numero intero

Identifica l'ID univoco del documento da modificare.

kdAttributes

String[]

Specifica le coppie nome-valore per l'aggiornamento, ad esempio, “SUMMARY”, ”Testo riepilogo”, “TITLE”, “Testo titolo”.

Come parte del metodo modifyDocument, la tabella seguente riporta degli esempi di valori di attributo validi, comunemente utilizzati per un documento. I dati nella colonna Tipo riflettono il tipo effettivo, che deve essere analizzato con il metodo in formato stringa nell'array di stringa attrVals.

Parametro

Tipo

Descrizione

MODIFY_DATE

(String)

Indica un campo speciale utilizzato per il "blocco dei record" che impedisce l'aggiornamento del documento da parte di due utenti simultaneamente. È necessario passare il valore del parametro MODIFY_DATE esistente del documento. Se non viene specificato alcun valore, viene restituito un errore che indica che un altro utente ha aggiornato il documento.

USER_DEF_ID

Stringa

Specifica qualsiasi ID che è possibile utilizzare per rappresentare il documento.

TITLE

Stringa

Indica il titolo del documento.

SUMMARY

Stringa

Indica il riepilogo del documento.

PROBLEM

Stringa

Indica il problema del documento.

RESOLUTION

Stringa

Indica la risoluzione del documento. Può contenere codice html.

STATUS_ID

Numero intero

Indica l'ID stato per il documento. Il valore predefinito è 10 (Bozza).

PRIORTY_ID

Numero intero

Indica l'ID priorità per il documento. Il valore predefinito è 20 (normale).

START_DATE

Date (String)

Indica la data di attivazione del documento, utilizzato anche insieme al parametro ExpirationDate. Lasciare vuoto per non specificare la data di inizio. Il documento diventa attivo a condizione che non sia stata raggiunta la data di scadenza.

EXPIRATION_DATE

Date (String)

Indica la data in cui il documento scade e viene utilizzato insieme al parametro StartDate. Lasciare vuoto per non specificare una data di scadenza.

SD_PRODUCT_ID

Numero intero

Indica l'ID prodotto di CA SDM con cui associare il documento.

ASSIGNEE_ID

UUID

Indica l'ID univoco di CA SDM a cui è assegnato questo documento.

SD_ASSET_ID

UUID

Indica l'ID asset di CA SDM con cui associare il documento.

SD_ROOTCAUSE_ID

Numero intero

Indica l'ID causa principale di CA SDM con cui associare il documento.

SD_PRIORITY_ID

Numero intero

Indica l'ID priorità di CA SDM con cui associare il documento.

SD_SEVERITY_ID

Numero intero

Indica l'ID gravità di CA SDM con cui associare il documento.

SD_IMPACT_ID

Numero intero

Indica l'ID impatto di CA SDM con cui associare il documento.

SD_URGENCY_ID

Numero intero

Specifica l'ID urgenza di CA SDM con cui associare il documento.

AUTHOR_ID

UUID

Identifica l'ID univoco del contatto che ha creato il documento. Se l'autore non è un contatto interno, è possibile impostare questo campo su zero (0) e utilizzare il parametro Author.

OWNER_ID

UUID

Identifica l'ID univoco del contatto a cui appartiene il documento.

SUBJECT_EXPERT_ID

UUID

Indica l'ID univoco del contatto che rappresenta il la persona esperta del documento.

NOTES

Stringa

Indica le note per il documento.

READ_GROUP_LIST

Stringa

Indica l'elenco di id gruppo separati da trattini con autorizzazione in lettura per il documento (ad esempio: 1-3-4). Utilizzare A per assegnare autorizzazioni a chiunque.

WRITE_GROUP_LIST

Stringa

Indica l'elenco di ID gruppo separati da trattini con autorizzazione in scrittura per il documento (ad esempio: 1-3-4). Utilizzare A per assegnare autorizzazioni a chiunque.

INHERIT_PERMISSION

Boolean

Indica lo stato del flag per ereditare le autorizzazioni. Impostare il valore su True per ereditare le autorizzazioni dalla categoria utilizzata per creare il documento. Se il valore è True, i parametri ReadPermissions e WritePermissions vengono ignorati.

DOC_TYPE_ID

Numero intero

Identifica l'ID che verrà associato al tipo di documento creato; un documento normale o un documento struttura. Il valore predefinito è un documento normale.

HITS

Numero intero

Indica il numero di visualizzazioni del documento.

DOC_TEMPLATE_ID

Numero intero

Identifica l'ID del modello che si desidera assegnare a questo documento.

WF_TEMPLATE

Numero intero

Identifica l'ID del modello di flusso di lavoro che si desidera assegnare al documento.

WF_ACTION

Stringa

Identifica l'azione del flusso di lavoro che si desidera assegnare al documento. Ad esempio, wf_unpublish consente di annullare la pubblicazione del documento.

WF_COMMENT

Stringa

Identifica il commento del flusso di lavoro che si desidera assegnare al documento. Ad esempio, unpublish.

WF_CONTACT_ID

UUID

Identifica l'ID utente per il flusso di lavoro che si desidera assegnare al documento.

WF_REJECT_TO_ID

Numero intero

Identifica l'id attività per il flusso di lavoro che si desidera assegnare al documento, mettendo in corrispondenza il processo di approvazione. Gli ID attività sono memorizzati nella tabella CI_ACTIONS.

CUSTOM1

Stringa

Indica un campo personalizzato.

CUSTOM2

Stringa

Indica un campo personalizzato.

CUSTOM3

Stringa

Indica un campo personalizzato.

CUSTOM4

Stringa

Indica un campo personalizzato.

CUSTOM5

Stringa

Indica un campo personalizzato.

CUSTOMNUM1

Double

Indica un campo personalizzato numerico.

CUSTOMNUM2

Double

Indica un campo personalizzato numerico.

Descrizione

Modifica un documento.

Valore restituito

Un nodo <UDSObject> che descrive il documento di conoscenza modificato.