Presentation from Dreamforce 2014 on using the Tooling API to create increased support for calling SOAP based web services using WSDLs to generate Apex.

1. Using the Tooling API to Generate
Apex SOAP Web Service Clients
Daniel Ballinger
Senior Developer
@FishOfPrey

2. Daniel Ballinger
Senior Developer
@FishOfPrey

3. Have you ever seen…
Feature Limits
Apex and
Deployment
No file chosen
Choose File
Error: Failed to parse wsdl: Unknown element: import
No file chosen
Choose File
Error: Failed to parse wsdl: Found more than one wsdl:binding. WSDL with multiple binding not supported
Apex Generation Failed
Unsupported WSDL. Found more than one part for message XAVRequestMessage
Apex Generation Failed
Unsupported schema type: {http://www.w3.org/2001/XMLSchema}anyType
Apex Generation Failed
The total size of apex code in this application after removing comments exceeds the maximum character size of
3000000
Apex Generation Failed
Class name 'toolingSoapSforceCom' already in use. Please delete this class or specify a new class name
Supported WSDL Features
http://www.salesforce.com/us/developer/docs/apexcode/Content/apex_callouts_wsdl2apex.htm#supported_wsdls_topic-title

4. In This Session
•The FuseIT SFDC Explorer tool
• Existing Salesforce WSDL functionality
•Demo custom WSDL to Apex tooling
•How it was made

5. The FuseIT SFDC Explorer Tool – FusesFriend
• Features
• Windows only for the full tool
• Basic web version of WSDL tooling
– Session management
– Schema Explorer + Tooling API
– SOQL queries
– Running Test Cases
– Debug Log Monitoring
– Data Export Retrieval
– Anonymous Apex
– Code Coverage
– WSDL import to Apex
http://www.fuseit.com/explorer

6. Unsupported
feature
Existing WSDL2Apex Experience
WSDL
> 1 MB
<xsd:import>
<xsd:include>
Existing Class
Name
Manually
Edit WSDL
Superfluous
bindings
Download
single WSDL
Generate
from WSDL
Upload
single WSDL
Namespaces
to Classes
Generate
Apex Code
Call
Generated
Code

7. Shaving the [WSDL] Yak
“Yak shaving is what you are doing when you're doing
some stupid, fiddly little task that bears no obvious
relationship to what you're supposed to be working
on, but yet a chain of twelve causal relations links
what you're doing to the original meta-task.”
Scott Hanselman
Photo by Dennis Jarvis CC BY-SA 3.0

8. Demo
SFDC Explorer Basic

9. The IT Crowd – Series 1 Episode 2: Fire!

10. Code Coverage Testing for Generated Code
•Need to implement WebServiceMock Interface
• Invoke each web service method
•Handle Request and Response types
•Supporting Types (Headers)

11. Demo
SFDC Explorer Web Service Mock

12. The Metadata API – Handling larger WSDLs
Class name 'Metadata' already in use.
Please edit WSDL to remove repeated
names
• CustomObject et al. extend Metadata and
need elements from it to work correctly.
<xs:extension base="Metadata">
• 330 KB WSDL
Apex Character Limit
Metadata
590,915
Remaining
• 590,915 characters / 6740 lines
without comments
• Approximately 20% of 3,000,000
character Apex limit

13. Method filtering functionality
•Reduces amount of generated code
•Reduces testing requirements for dead code
• Potentially skips unsupported features
• Optionally remove supporting Apex classes

14. Demo
SFDC Explorer Method filtering

15. How it works
Deploy to
Salesforce
• Tooling API to
deploy all
associated Apex
classes at once
Transform
to Apex
• T4 (Text Template
Transformation
Toolkit)Templates to
convert the object
model into Apex
Build Apex
Model
• C# Object Model of
Apex Classes,
Members and
Methods
Parse
WSDL
• Import all WSDL
data and extract
required elements

16. .NET Representation of Apex Class model
ApexClass
1 InnerApexClasses * Members * Methods
ApexClassCollection ApexMember
StringArrayApexMember
ApexMethod
ApexMethodParameter
ApexMethodHttp
ReturnType
ReturnVoid ReturnPrimitive ReturnClassType
Type Infos
Inner Classes
Namespace Collection
Parameters
*
ReturnType
1
ApexClasses
0..*
Outer class for each Namespace
Created for the Port/Service
Each Request/Response

17. Tooling API deployment
Existing ID
• Create a MetadataContainer with a
unique name
• Create a collection of
ApexClassMember referencing the
MetadataContainerId
• Create a ContainerAsyncRequest
– Option to Validate Only (IsCheckOnly)
• Keep retrieving until the State is no
longer Queued.
• Delete MetadataContainer
New – no existing ID
• Call create and collect the SaveResults
• Or create an empty stub class to get an
ID and use the MetadataContainer

18. Tooling API deployment
Existing ID
• Create a MetadataContainer with a
unique name
• Create a collection of
ApexClassMember referencing the
MetadataContainerId
• Create a ContainerAsyncRequest
New – no existing ID
• Call create and collect the SaveResults
• Or create an empty stub class to get an
ID and use the MetadataContainer
List<ApexClass> apexClassesToInsert = new List<ApexClass>();
// Add ApexClass records with T4 generated Body
ApexClass classToInsert = new ApexClass() { Name = "HelloDF" };
classToInsert.Body = "public class " + classToInsert.Name + " { public class Add{ }}";
apexClasses.Add(classToInsert);
– Option to Validate Only (IsCheckOnly)
• Keep retrieving until the State is no
longer Queued.
• Delete MetadataContainer
SaveResult[] saveResults = toolingService.create(apexClassesToInsert.ToArray());
if (saveResults != null) {
foreach (SaveResult sr in saveResults) {
if (!sr.success) {
throw new ToolingCreateException(apexClassesToInsert.ToArray(), saveResults);
}
}
}

19. Tooling API deployment
Existing ID
• Create a MetadataContainer with a
unique name
• Create a collection of
ApexClassMember referencing the
MetadataContainerId
• Create a ContainerAsyncRequest
New – no existing ID
• Call create and collect the SaveResults
• Or create an empty stub class to get an
MIeDta adantda Cuosntea ithneer McoenttaadianetarC=onnetwaiMneetradataContainer();
– Option to Validate Only (IsCheckOnly)
• Keep retrieving until the State is no
longer Queued.
• Delete MetadataContainer
// max length 32 characters!
container.Name = "UAC " + DateTime.Now.Ticks;
SaveResult[] containerResults = toolingService.create(new sObject[] { container });
if (!containerResults[0].success) {
throw new ToolingCreateException(container, containerResults[0]);
}
Id metadataContainerId = new Id(containerResults[0].id);

20. Tooling API deployment
Existing ID
• Create a MetadataContainer with a
unique name
• Create a collection of
ApexClassMember referencing the
MetadataContainerId
• Create a ContainerAsyncRequest
– Option to Validate Only (IsCheckOnly)
• Keep retrieving until the State is no
longer Queued.
• Delete MetadataContainer
New – no existing ID
• Call create and collect the SaveResults
• Or create an empty stub class to get an
ID and use the MetadataContainer
var toUpdate = new List<ApexClassMember>();
foreach(ApexClass ac in classesToUpsert) {
var acm = new ApexClassMember();
acm.ContentEntityId = ac.Id; // 01p…
acm.Body = ac.Body; // T4 Template output
acm.FullName = ac.Name; // class name
acm.MetadataContainerId =
metadataContainerId.CaseSafeID;
toUpdate.Add(acm);
}
sObject[] toCreate = toUpdate.ToArray();
SaveResult[] cResult =
toolingService.create(apexClassMembersToCreate);
foreach (SaveResult sr in cResult) {
if (!sr.success) {
throw new ToolingCreateException(toCreate,
cResult);
}
}

21. Tooling API deployment
Existing ID
• Create a MetadataContainer with a
unique name
• Create a collection of
ApexClassMember referencing the
MetadataContainerId
• Create a ContainerAsyncRequest
– Option to Validate Only (IsCheckOnly)
• Keep retrieving until the State is no
longer Queued.
• Delete MetadataContainer
var cr = new ContainerAsyncRequest();
cr.MetadataContainerId =
metadataContainerId.CaseSafeID;
cr.IsCheckOnly = false;
SaveResult[] cars = this.create(new sObject[]{cr});
if (! cars[0].success) {
throw new ToolingCreateException(cr,cars[0]);
}
ContainerAsyncRequest retrieve =
WaitForClassToUpdate(containerAsyncResults);
if (retrieve.State == "Failed") {
throw ApexUpdateException.FromDeployDetails
(retrieve.DeployDetails);
}
DeleteResult[] dr = this.delete(new string[]
{ metadataContainerId.CaseSafeID });

22. WSDL Variation
http://www.superbwallpapers.com/photography/snowflakes-10358/
If you have a unique WSDL:
• http://www.fuseit.com/wsdlhelp
• Please provide the WSDL details
Use HTTP Requests for
WebServiceCallout.invoke
limits

23. Summary
•Manually dealing with WSDL import errors is time consuming
and error prone
• Extended SOAP support for several common WSDL issues:
– Increased support – <xsd:import> <xsd:include> <xsd:extension>
– Generate basic code coverage
– Method filtering to reduce Apex

24. Q&A
+ What Next
• Download: the free FuseIT SFDC Explorer Tool (or get the web version)
http://www.fuseit.com/explorer
• Idea: Run anonymous apex as if it were a test case
http://goo.gl/Aci1ys
• Salesforce: The now open source WSDL2Apex generator
http://goo.gl/tUcnVj
• Session: Building Callouts Without WSDL2Apex and Apex Parsers
Tuesday, 4:00 PM - 4:30 PM | Moscone Center West | Mobile Theater
www.fuseit.com
@FishOfPrey
www.fishofprey.com
@GirishaArora
Girisha Arora

26. Bonus Slides

27. Handling Extensions
• <xsd:extension base=“”/>
• Copy fields from base type to the
sub class.
• Use extends in the future
• Metadata API
• AccountOwnerSharingRule extends
• OwnerSharingRule extends
• BaseSharingRule extends
• Metadata

28. HTTP Requests
• When WebServiceCallout.invoke() fails
• A template for supporting more complex callouts
• Access full fault messages
SOAPFault Information for Apex
https://success.salesforce.com/ideaView?id=08730000000BqG9AAK

29. Apex Class Drifting with WSDL changes