Adobe Acrobat Sign for Salesforce: Utviklerveiledning

Adobe Acrobat Sign for Salesforce: Utviklerveiledningen er utformet for å hjelpe Salesforce-utviklere, slik at de kan lære om objektene og parametrene som kreves for å integrere Salesforce-pakken i Adobe Acrobat Sign.

• Hvis du trenger å vite når avtalen er fullstendig signert, implementerer du en Apex-utløser på objektet echosign_dev1__SIGN_Agreement__c, etter eller før oppdatering (avhengig av brukstilfelle og krav). Når echosign_dev1__Status__c-feltet endres til Signert eller Godkjent eller andre endelige statuser, er avtalen fullført. 
• Hvis du vil vite når hver enkelt signert PDF-fil settes inn, hvis du for eksempel trenger hver mellomliggende signert PDF-fil, må du implementere en Apex-utløser på vedleggs- eller innholdsversjonsobjektene, etter innsetting, og se etter en overordnet avtale og et navn som slutter på «- signed.pdf» eller «- approved.pdf» eller en annen endelig status
• Hvis du trenger å vite når en individuell mottaker har signert eller godkjent, implementerer du en Apex-utløser på echosign_dev1__SIGN_Recipients __ c-objektet, etter eller før oppdatering (avhengig av brukstilfelle og krav). Når echosign_dev1__Status__c-feltet endrer Signert eller Godkjent eller andre endelige statuser, er mottakeren fullført.  
• Hvis du trenger å vite når en bestemt hendelse som er en del av signeringsprosessen, for eksempel en avtale som sendes for signering eller en påminnelse som sendes, kan en utløser opprettes på avtalehendelsesobjektet (echosign_dev1__SIGN_AgreementEvent __c) og se etter hendelsestypen
• De endelige avtalestatusnavnene for en fullført avtale er: «Signert», «Godkjent», «Akseptert», «Skjema fylt» og «Levert»
  
• De endelige avtalestatusnavnene for en avsluttet avtale er: «Avbrutt / avslått», «Avbrutt / avslått», «Utløpt»

Oppdateringsrekkefølge

I v21 er oppdateringsrekkefølgen endret. Nedenfor er sekvensen som avtalen og dens relaterte objekter oppdateres etter:

1. Vedlegg 
2. Mottakere 
3. Avtale (status og dens andre attributter)
4. Avtalehendelser 
5. Chatter-feeder 

Apex-tjenester

Apex-metode i bruk

Fra og med Acrobat Sign for Salesforce V 21.0 har alle asynkrone prosesser (som inkluderer automatiske oppdateringer og datatilordninger) blitt byttet fra fremtidige metoder til køleggingsbare, en tilnærming anbefalt av Salesforce.

Med denne endringen vil alle tilpasinger i abonnent-organisasjonen som legger til jobber i Salesforce-køen som en del av denne prosessen for automatisk oppdatering eller datakartlegging mislykkes med en feil «System.LimitException: For mange køleggingsbare jobber lagt til i køen: 2».

Feilen oppstår fordi en køleggingsbar prosess bare kan legge til én underordnet køleggingsbar jobb, som allerede er i bruk av Acrobat Sign. For detaljer, kan du se Køleggingsbare Apex-grenser.

Feil: «Når du lenker jobber, kan du bare legge til én jobb fra en utførende jobb med System.enqueueJob, som betyr at det bare kan finnes én underordnet jobb for hver overordnet køleggingsbar jobb. Det er ikke støtte for å starte flere underordnede jobber fra samme køleggingsbare jobb.»

Ovennevnte feil oppstår når avtalestatusen ikke endres eller datatilordningen ikke kjører som den skal. For å rette denne feilen må du se etter den problematiske utløseren, prosessbyggeren eller arbeidsflyten og deaktivere den eller endre den til å bruke et synkront kall eller planlegge den for senere kjøring.

Avtalemaltjeneste

Avtalemaltjenesten eksponeres som en global Apex-tjeneste av den administrerte pakken. Dette tillater Apex-kode utenfor den administrerte pakken å laste inn avtaler basert på eksisterende avtalemaler. Klassen og alle eksponerte metoder er merket som globale for å tillate slik tilgang.

Apex-tjenesten eksponeres gjennom følgende påkallelsesklasse: echosign_dev1.AgreementTemplateService

  Metoder

 Konstruktører (1)

global class AgreementTemplateService.AgreementTemplateListOptions

Egenskaper (5)

global class AgreementTemplateService.AgreementTemplateBasicInfo

Egenskaper (6)

global class AgreementTemplateService.AgreementTemplateDetails

Egenskaper (6)

global class AgreementTemplateService.RecipientInfo

Egenskaper (4)

Kjøretidsvariabler

Den globale klassen echosign_dev1.AgreementTemplateVariable har to globale felt.

• navn: Variabelnavnet, som må samsvare med et navn på kjøretidsvariabel konfigurert i avtalemalen.
• verdi: Verdien til variabelen som skal brukes under malbelastningen. Verdien avhenger av hvor variabelen ble brukt. For en mottaker må det for eksempel være en kontakt-, salgsemne- eller brukerpost-ID eller en e-post. For en dokumentvariabel må den være en vedleggspost-ID.

Resultat

Hver metode returnerer enten ID for den nyopprettede avtaleposten eller utløser et unntak med en detaljert feilmelding hvis noe gikk galt under lasteoperasjonen.

API-tjeneste

Adobe e-Sign API-maltjenesten eksponeres som en global Apex-tjeneste av den administrerte pakken. Dette gjør det mulig for Apex-kode utenfor den administrerte pakken å starte et sett med Adobe e-Sign API-er gjennom disse pakkerene. Pakkerene forenkler i stor grad API-kallet fordi forbrukerne ikke trenger å opprette forespørsels- og svardatamodell. Det er heller ikke nødvendig for forbrukerne å håndtere transformasjonen av Salesforce-data til e-Sign-datamodeller. Det meste av kompleksiteten er hentet fra forbrukeren. For å sende en avtale som forbrukeren bare sender videre i avtaleoppføring-ID-en, vil tjenesten for eksempel håndtere spørring, trekke ut alle relevante data, sende det videre til API-en og analysere resultatet.

Klassen og alle eksponerte metoder er merket som globale for å tillate slik tilgang.

• v17 og under starter SOAP-API-er
• v18 og over starter REST API-er

Apex-tjenesten eksponeres gjennom følgende påkallelsesklasse: echosign_dev1.EchoSignApiService

Metoder

Innerklasser

global class DocumentHistoryEvent

Egenskaper (2)

Konstruktører (1)

global class DocumentInfo

Egenskaper (5)

Konstruktører (1)

global class ParticipantInfo

Egenskaper (5)

Konstruktører (1)

global class SendDocumentResult

Egenskaper (3)

Konstruktører (1)

global class SigningUrl

Egenskaper (3)

Konstruktører (1)

Apex-gruppetjenester

Avslører de viktigste tiltakene i e-signeringsavtalen på massenivå, slik at en operasjon kan utføres på et sett med avtaler. Denne klassen implementerer Salesforce Database.Batchable -grensesnittet. Det kan behandle et hvilket som helst antall oppføringer, som vil bli brutt ned i sett på 5, og behandle hvert sett som en individuell transaksjon, som gjør det mulig å respektere regulatorgrensene.

Apex-gruppetjenesten eksponeres gjennom følgende påkallelsesklasse: echosign_dev1.EchoSignActionBatch

Parametere

Følgende parametere må angis for å initialisere en gruppeoperasjon.

En liste over avtalepost-ID-er som den angitte handlingen skal utføres på. Handlingen som skal utføres, én av følgende verdier som støttes:

• Påminn
• Send
• Avbryt
• Slett
• Oppdater

Gjeldende brukerøkt-ID. Kreves bare for en oppdateringshandlingstype.

Innsenders brukerpost, brukes til å varsle denne brukeren via en e-post når massebehandlingen er fullført.

Brukseksempel

User submitterUser = UserInfo.getUserId();

EchoSignActionBatch batch = new EchoSignActionBatch( agreementIds, 'Remind', UserInfo.getSessionId(), submitterUser); syncProcessId = Database.executeBatch(batch, 5);

Avtalemalgruppe

Tar inn en SOQL-spørring og en avtalemalpost-ID. Spørringen utføres for å få et sett med hovedobjektoppføringer, som hver deretter kjøres gjennom den medfølgende avtalemalen for å generere en avtaleoppføring. Denne klassen implementerer Salesforce Database.Batchable-grensesnittet. Det kan behandle et hvilket som helst antall oppføringer, som vil bli brutt ned i sett på 5, og behandle hvert sett som en individuell transaksjon, som gjør det mulig å respektere regulatorgrensene.

Posttypene som returneres av SOQL-spørringen, må samsvare med den angitte hovedkontotype for avtalemal. For hver post blir avtalemalen for tjenesten påkalt.

Apex batch-tjenesten eksponeres gjennom følgende påkallelsesklasse:

echosign_dev1.AgreementTemplateBatch

Parametere

Følgende parametere må angis for å initialisere en gruppeoperasjon.

SOQL-spørring som skal utføres, må inneholde post-ID-en som et valgt felt. Annenhvert felt er valgfritt.

Avtalemalpost-ID, som vil bli brukt i forbindelse med hovedpost-ID for å laste inn en avtale.

Brukseksempel

String agreementTemplateId = [SELECT Id from echosign_dev1__Agreement_Template__c where Name = 'Default Template']; String soqlQuery = 'SELECT Id from Contact where Account.IsActive = true';

AgreementTemplateBatch batch = new AgreementTemplateBatch(soqlQuery, agreementTemplateId); syncProcessId = Database.executeBatch(batch, 5);

Avtalemaltjenestegruppe

Tar inn en liste over hovedobjektoppføring-ID-er og hovedobjekttypen, som deretter spørres og som så kjøres gjennom den medfølgende avtalemalen for å generere en avtalepost. Denne klassen implementerer Salesforce Database.Batchable-grensesnitt. Det kan behandle et hvilket som helst antall oppføringer, som vil bli brutt ned i sett på 5, og behandle hvert sett som en individuell transaksjon, som gjør det mulig å respektere regulatorgrensene.

Den angitte hovedobjekttypen må samsvare med den angitte avtalemalen for hovedobjekttype. For hver post blir avtalemalen for tjenesten påkalt.

Apex batch-tjenesten eksponeres gjennom følgende påkallelsesklasse:

echosign_dev1.AgreementTemplateServiceBatch

Parametere

Følgende parametere må angis for å initialisere en gruppeoperasjon.

• Liste over hovedpost-ID-er.
• Avtalemalpost-ID, som vil bli brukt i forbindelse med hovedpostene for å laste inn en avtale.
• Navnet på hovedobjektet som skal spørres etter hovedpostene.

Brukseksempel

String agreementTemplateId = [SELECT Id from echosign_dev1__Agreement_Template__c where Name = 'Default Template'];

AgreementTemplateBatch batch = new AgreementTemplateServiceBatch(new List<Id>{'01p50000000HoMB'}, agreementTemplateId, 'Contact');
syncProcessId = Database.executeBatch(batch, 5);

REST-tjenester

Avtalemaltjeneste

Avtalemaltjenesten eksponeres som en Salesforce REST-webtjeneste av den administrerte pakken. Dette gjør det mulig for eksterne systemer utenfor Salesforce-organisasjonen å laste inn avtaler basert på eksisterende avtalemaler. Se artikkelen Opprette REST API-er ved hjelp av Apex REST for mer informasjon om hvordan du får tilgang til og bruker tilpassede REST Apex-tjenester fra Salesforce. Det må oppgis en gyldig økt-ID for godkjenning og autorisasjon.

Webtjenesten eksponeres fra følgende nettadresse:

https://<instance_name>.salesforce.com/services/apexrest/echosign_dev1/template/load/<template_id>?masterId=<master_id>&varName1=var Value1&varName2=varValue2

Mal-ID

Den siste delen av nettadressen er ID-en til avtalemalposten i gjeldende Salesforce-organisasjon, som skal brukes til å laste inn avtalen. Denne delen av nettadressen er valgfri. Hvis utelatt, vil avtalemalen merket som standard bli lastet inn. Hvis mal-ID-en utelates og det ikke finnes noen standard avtalemal-ID, returneres en feil.

Mal-ID-en kan være i format på 15 eller 18 tegn.

Hoved-ID

Hoved-ID-parameteren angir hvilken hovedpost som skal brukes til å laste avtalen fra den spesifikke avtalemalen. Denne parameteren er valgfri, men må angis for en avtalemal som angir en overordnet objekttype og refererer til dette overordnede objektet i malen.

Hoved-ID-en kan være i format på 15 eller 18 tegn.

Kjøretidsvariabler

Eventuelle tilleggsparametere brukes som kjøretidsvariabler, som navneverdipar, brukes til å fylle ut eventuelle kjøretidsvariabler angitt i avtalemalen.

Resultat

REST-webtjenesten returnerer et LoadResult-objekt som inneholder følgende felt:

• agreementId: Hvis avtaleinnlastingsoperasjonen var vellykket, inneholder denne ID-en til den nyopprettede avtaleposten.
• feil: Hvis det var noen feil under lasting av avtalen, vil dette feltet inneholde en detaljert feilmelding.

Bakgrunnstjeneste

Funksjonen Bakgrunnstjeneste gjør det mulig for pakkeforbrukere å påberope seg ulike handlinger på et avtaleobjekt ved å oppdatere feltet Bakgrunnshandling (echosign_dev1 Background_Actions c) til tilsvarende verdi. Når feltverdien er endret fra en tom verdi eller en annen verdi til én av følgende verdier, blir handlingen startet fra en utløser som er en del av den e-Sign-administrerte pakken.

• Påminn
• Send
• Avbryt
• Slett
• Oppdater

Alle handlingene utføres i en asynkron fremtidig modus, slik at statusen vil bli lagret i Feil-feltet i avtalen.

Endringer i bakoverkompatibilitet