|
<< Fare clic per visualizzazione il sommario >> Percorso: API di piattaforma > JamioPlug > JamioPlug Digitalitaly > Registrazione di protocollo e interoperabilità > Configurare DocumentRegistration |
Per poter utilizzare il servizio DocumentRegistration del JamioPlug Digitalitaly è necessario configurarlo tramite risorsa di tipo configurazione e utilizzare una casella PEC, anch'essa opportunamente configurata. Si ricorda che per poter usufruire del JamioPlug Digitalitaly in esecuzione sulla propria area Jamio è necessario contattare il customer service.
La configurazione coincide con la creazione della definizione di un Registro di protocollo.
La risorsa di tipo configurazione deve avere valorizzate le proprietà come segue:
PlugName: Digitalitaly;
ServiceName: DocumentRegistration;
Name: Nome da assegnare alla configurazione;
Description: descrizione opzionale della configurazione;
AuthorizationScheme: 0;
Fields: Dataset contenente i campi riportati nelle tabelle che seguono.
Nickname: rappresenta il numero del Registro di protocollo e viene composto da alcuni Fields, come di seguito descritti, nella seguente forma: [AdministrationCode]-[AOOCode]-[RegisterNumber]. Per quanto riguarda i caratteri speciali ammessi:
•può contenere lettere maiuscole e minuscole dell'alfabeto inglese, numeri e i caratteri "-", "_", "."
•non è case-sensitive
•non può iniziare con uno dei caratteri "-", "_", "."
•non può terminare con ".":
Impostazioni generali di Jamio DocumentRegistration |
|||
Nome |
Descrizione |
Tipo |
Opzionale |
RegisterName |
Testo che indica il nome del registro di Protocollo. |
String |
|
RegisterNumber |
Testo che indica il numero del registro di Protocollo. |
String |
|
AdministrationCode |
Testo che indica il codice IPA dell’amministrazione a cui è legata la configurazione ovvero il registro di Protocollo. |
String |
|
AdministrationName |
Testo che indica il nome IPA dell’amministrazione a cui è legata la configurazione ovvero il registro di Protocollo. |
String |
|
AdministrationDescription |
Testo che descrive dell’amministrazione a cui è legata la configurazione ovvero il registro di Protocollo. |
String |
Y |
AOOCode |
Testo che indica il codice AOO dell’amministrazione a cui è legata la configurazione ovvero il registro di Protocollo. |
String |
|
AOODescription |
Testo che descrive l'AOO dell’amministrazione a cui è legata la configurazione ovvero il registro di Protocollo. |
String |
Y |
CertificateCredentials |
Collegamento alle credenziali di un certificato utilizzato per il sigillo. |
Reference |
|
Collegamento alla configurazione della casella PEC a cui è riferito il registro di Protocollo. |
Reference |
Y |
|
TestMode |
Caratterizza la modalità operativa dei metodi richiamati con la configurazione. Se true, i metodi operano in modalità test. |
Boolean |
|
RegistrationScope |
Testo che caratterizza lo scopo della configurazione. |
String |
|
Impostazioni avanzate per la creazione di una registrazione di Protocollo in Jamio DocumentRegistration |
|||
Nome |
Descrizione |
Tipo |
Opzionale |
RegistrationModelReference |
Collegamento al modello di tipo Dati da istanziare per la registrazione di Protocollo. |
Reference |
|
RegisterNicknameField |
Testo che indica il nome del campo in cui è contenuto il Nickname della registrazione di Protocollo. Il valore di default è NicknameRegistro. |
String |
|
AdministrationCodeField |
Testo che indica il nome del campo che nella registrazione di Protocollo identifica il codice dell'amministrazione. Il valore di default è CodiceAmministrazione. |
String |
|
AdministrationDescriptionField |
Testo che indica il nome del campo che nella registrazione di Protocollo riporta la descrizione dell’amministrazione a cui è legato il registro di Protocollo. Il valore di default è DescrizioneAmministrazione. |
String |
|
AOOCodeField |
Testo che indica il nome del campo che nella registrazione di Protocollo riporta il codice AOO dell’amministrazione a cui è legato il registro di Protocollo. Il valore di default è CodiceAOO. |
String |
|
AOODescriptionField |
Testo che indica il nome del campo che nella registrazione di Protocollo descrive l'AOO dell’amministrazione a cui è legato il registro di Protocollo. Il valore di default è DescrizioneAOO. |
String |
|
Testo che indica il nome del campo che nella registrazione di Protocollo indica la tipologia di protocollo (in entrata, in uscita o registrazione interna). Il valore di default è TipologiaProtocollo. |
String |
|
|
RegisterNumberField |
Testo che indica il nome del campo che nella registrazione di Protocollo indica il Nickname. Il valore di default è NumeroRegistro. |
String |
|
SubjectField |
Testo che indica il nome del campo che nella registrazione ne valorizza l'Oggetto. Il valore di default è Oggetto. |
String |
|
PrimaryDocumentField |
Testo che indica il nome del campo che nella registrazione di Protocollo contiene il collegamento al documento principale. Il valore di default è RefFilePrimario. |
String |
|
AttachmentsField |
Testo che indica il nome del campo che nella registrazione di Protocollo contiene la lista di collegamenti agli altri allegati. Il valore di default è RefListaFileAllegati. |
String |
|
SignatureField |
Testo che indica il nome del campo che nella registrazione di Protocollo contiene il collegamento al file di segnatura Il valore di default è RefFileSegnatura. |
String |
|
SourceField |
Testo che indica il nome del campo che nella registrazione di Protocollo contiene il collegamento alla risorsa registrata. Il valore di default è RefOrigine. |
String |
Y |
OwnersField |
Testo che indica il nome del campo che nella registrazione di Protocollo contiene la lista di collegamenti alle risorse che hanno dato origine alla registrazione. Solo il primo della lista verrà contemplato nella segnatura di protocollo. Il valore di default è RefListaMittenti. |
String |
|
FootprintListField |
Testo che indica il nome del campo che nella registrazione di Protocollo contiene le impronte del documento protocollato. Il valore di default è ImprontaHash. |
String |
|
ClassificationField |
Testo che indica il nome del campo che nella registrazione di Protocollo contiene il collegamento alla classificazione Il valore di default è RefClassificazione. |
String |
|
ReceptionDateField |
Testo che indica il nome del campo in cui nella registrazione di Protocollo deve essere inserita la data di ricezione del messaggio da registrare. Il valore di default è DataRicezioneDoc. |
String |
Y |
Impostazioni avanzate per la ricerca nel registro di protocollo in base ai recapiti in Jamio DocumentRegistration |
|||
Nome |
Descrizione |
Tipo |
Opzionale |
ContactsCatalog |
Collegamento al catalogo dei contatti. |
Reference |
|
Impostazioni avanzate per la ricerca nel registro di protocollo in base all'identificativo della registrazione in Jamio DocumentRegistration |
|||
Nome |
Descrizione |
Tipo |
Opzionale |
Collegamento al catalogo utilizzato per la ricerca nel registro in base all’identificativo della registrazione. |
Reference |
|
|
RegisterNicknameColumn |
Testo che indica l'intestazione della colonna del catalogo referenziato dal parametro RegisterCatalog, che identifica il Nickname del registro. Il valore di default è NicknameRegistro. |
String |
|
RegistrationNumberColumn |
Testo che indica l'intestazione della colonna del catalogo referenziato dal parametro RegisterCatalog, che identifica il numero di registrazione nel registro. Il valore di default è NumeroRegistrazione. |
String |
|
Impostazioni avanzate per la ricerca nel registro di protocollo in base all'identificativo mittente in Jamio DocumentRegistration |
|||
Nome |
Descrizione |
Tipo |
Opzionale |
InRegisterCatalog |
Collegamento al catalogo utilizzato per la ricerca nel registro in base all’identificativo del mittente. |
Reference |
|
SenderRegistrationIdentifierColumn |
Testo che indica il nome della colonna del catalogo referenziato dal parametro InRegisterCatalog, che contiene il numero di protocollo dell'amministrazione che ha dato origine alla registrazione. Il valore di default è IdentificativoProtocolloMittente. |
String |
|
RegistrationSendingStatusColumn |
Testo che indica il nome della colonna del catalogo referenziato dal parametro InRegisterCatalog, che contiene informazioni sullo stato della Spedizione della registrazione Il valore di default è SendingStatus. |
String |
|
Impostazioni avanzate per l'invio di una Pec di interoperabilità in Jamio DocumentRegistration |
|||
Nome |
Descrizione |
Tipo |
Opzionale |
MessageModelReference |
Collegamento al modello di tipo Dati da istanziare per la PEC da inviare. |
Reference |
|
MessageToField |
Testo che indica il nome del campo che, nel modello referenziato dal collegamento nel parametro MessageModelReference, riporta la lista dei corrispondenti con cui è valorizzato il parametro to della PEC da inviare. |
String |
|
MessageCCField |
Testo che indica il nome del campo che, nel modello referenziato dal collegamento nel parametro MessageModelReference, riporta la lista dei corrispondenti con cui è valorizzato il parametro CC della PEC da inviare. |
String |
|
MessageSubjectField |
Testo che indica il nome del campo che, nel modello referenziato dal collegamento nel parametro MessageModelReference, identifica l'oggetto della PEC da inviare. |
String |
|
MessageBodyField |
Testo che indica il nome del campo che, nel modello referenziato dal collegamento nel parametro MessageModelReference, identifica il contenuto della PEC da inviare. |
String |
|
MessageCarrierField |
Testo che indica il nome del campo che, nel modello referenziato dal collegamento nel parametro MessageModelReference, identifica il carrier della PEC da inviare. |
String |
|
MessageTransportField |
Testo che indica il nome del campo che, nel modello referenziato dal collegamento nel parametro MessageModelReference, identifica il trasporto della PEC da inviare. |
String |
|
MessageCorrespondentField |
Testo che indica il nome del campo che, nel modello referenziato dal collegamento nel parametro MessageModelReference, identifica il corrispondente della PEC da inviare. |
String |
|
MessageAddressField |
Testo che indica il nome del campo che, nel modello referenziato dal collegamento nel parametro MessageModelReference, identifica l'address della PEC da inviare. |
String |
|
Ulteriori campi utili per l'invio delle PEC di interoperabilità sono legati ai campi dei collegamenti estesi, in cui corrispondente, l'indirizzo e il trasporto sono comuni al mapping precedente sulla struttura del dataOut.
Mapping del collegamento esteso che individua la struttura di un mittente o destinatario in Jamio DocumentRegistration |
|||
Nome |
Descrizione |
Tipo |
Opzionale |
ContactTypeField |
Testo che indica il nome del campo che nella registrazione di Protocollo identifica la tipologia di anagrafica. Il valore di default è TipologiaAnagrafica. |
String |
|
TransportContactField |
Testo che indica il nome del campo che nella registrazione di Protocollo identifica la tipologia di trasporto. Il valore di default è TipoRecapito. |
String |
|
TransportDescriptionContactField |
Testo che indica il nome del campo che nella registrazione di Protocollo contiene la tipologia di trasporto. Il valore di default è DescrRecapito. |
String |
|
TrackProcessingContactField |
Testo che indica il nome del campo che nella registrazione di Protocollo indica se è richiesta l'interoperabilità per quel contatto. Il valore di default è ConfermaRicezione. |
String |
|
NameContactField |
Testo che indica il nome del campo che nella registrazione di Protocollo riporta la denominazione di un Ente (italiano o estero) o di una Persona Giuridica. Il valore di default è Denominazione. |
String |
|
UONameContactField |
Testo che indica il nome del campo che nella registrazione di Protocollo riporta la denominazione di una UO italiana o estera. Il valore di default è DenominazioneUO. |
String |
|
AOONameContactField |
Testo che indica il nome del campo che nella registrazione di Protocollo indica il nome dell'AOO dell’amministrazione Il valore di default è DenominazioneAOO. |
String |
|
AdministrationCodeContactField |
Testo che indica il nome del campo che nella registrazione di Protocollo indica il codice dell’amministrazione. Il valore di default è CodiceAmministrazione. |
String |
|
AOOCodeContactField |
Testo che indica il nome del campo che nella registrazione indica il codice AOO. Il valore di default è CodiceAOO. |
String |
|
UOCodeContactField |
Testo che indica il nome del campo che nella registrazione di Protocollo contiene il codice dell'UO. Il valore di default è CodiceUO. |
String |
|
FiscalCodeOrVATContactField |
Testo che indica il nome del campo che nella registrazione di Protocollo contiene il codice univoco del contatto (Codice Fiscale o P. IVA). Il valore di default è PIVAoCF. |
String |
|
FirstNameContactField |
Testo che indica il nome del campo che nella registrazione di Protocollo contiene il nome di una persona fisica. Il valore di default è Nome. |
String |
|
LastNameContactField |
Testo che indica il nome del campo che nella registrazione di Protocollo contiene il cognome di una persona fisica. Il valore di default è Cognome. |
String |
|
AddressContactField |
Testo che indica il nome del campo che nella registrazione di Protocollo contiene l'indirizzo di una persona fisica. Il valore di default è Indirizzo. |
String |
|
PostalAddressContactField |
Testo che indica il nome del campo che nella registrazione di Protocollo contiene il collegamento esteso all'indirizzo di una persona fisica. Il valore di default è IndirizzoPostale. |
String |
|
NominativeContactField |
Testo che indica il nome del campo che nella registrazione di Protocollo identifica il corrispondente. Il valore di default è Nominativo. |
String |
|
UpdateContactResourceField |
Testo che indica il nome del campo booleano utile per richiedere l'aggiornamento dell'anagrafica. Il valore di default è AggiornaAnagrafica. |
String |
|
AddContactResorceField |
Testo che indica il nome del campo booleano utile per richiedere l'inserimento in anagrafica. Il valore di default è InserisciAnagrafica. |
String |
|