diff --git a/lib/WebGUI/Asset/Wobject/WSClient.pm b/lib/WebGUI/Asset/Wobject/WSClient.pm index 578dc7c27..c91ffb3cf 100644 --- a/lib/WebGUI/Asset/Wobject/WSClient.pm +++ b/lib/WebGUI/Asset/Wobject/WSClient.pm @@ -158,46 +158,55 @@ sub getEditForm { -value => $self->getValue('templateId'), -namespace => "WSClient", -label => WebGUI::International::get(72, "Asset_WSClient"), + -hoverHelp => WebGUI::International::get('72 description', "Asset_WSClient"), ); $tabform->getTab("display")->yesNo ( -name => 'preprocessMacros', -label => WebGUI::International::get(8, "Asset_WSClient"), + -hoverHelp => WebGUI::International::get('8 description', "Asset_WSClient"), -value => $self->get('preprocessMacros'), ); $tabform->getTab("display")->integer( -name => 'paginateAfter', -label => WebGUI::International::get(13, "Asset_WSClient"), + -hoverHelp => WebGUI::International::get('13 description', "Asset_WSClient"), -value => $self->getValue("paginateAfter") ); $tabform->getTab("display")->text ( -name => 'paginateVar', -label => WebGUI::International::get(14, "Asset_WSClient"), + -hoverHelp => WebGUI::International::get('14 description', "Asset_WSClient"), -value => $self->get('paginateVar'), ); $tabform->getTab("properties")->text ( -name => 'uri', -label => WebGUI::International::get(2, "Asset_WSClient"), + -hoverHelp => WebGUI::International::get('2 description', "Asset_WSClient"), -value => $self->get('uri'), ); $tabform->getTab("properties")->text ( -name => 'proxy', -label => WebGUI::International::get(3, "Asset_WSClient"), + -hoverHelp => WebGUI::International::get('3 description', "Asset_WSClient"), -value => $self->get('proxy'), ); $tabform->getTab("properties")->text ( -name => 'callMethod', -label => WebGUI::International::get(4, "Asset_WSClient"), + -hoverHelp => WebGUI::International::get('4 description', "Asset_WSClient"), -value => $self->get('callMethod'), ); $tabform->getTab("properties")->textarea ( -name => 'params', -label => WebGUI::International::get(5, "Asset_WSClient"), + -hoverHelp => WebGUI::International::get('5 description', "Asset_WSClient"), -value => $self->get('params'), ); if ($session{'config'}{'soapHttpHeaderOverride'}) { $tabform->getTab("properties")->text ( -name => 'httpHeader', -label => WebGUI::International::get(16, "Asset_WSClient"), + -hoverHelp => WebGUI::International::get('16 description', "Asset_WSClient"), -value => $self->get('httpHeader'), ); } else { @@ -210,17 +219,20 @@ sub getEditForm { $tabform->getTab("properties")->yesNo ( -name => 'execute_by_default', -label => WebGUI::International::get(11, "Asset_WSClient"), + -hoverHelp => WebGUI::International::get('11 description', "Asset_WSClient"), -value => $self->get('execute_by_default'), ); $tabform->getTab("properties")->yesNo ( -name => 'debugMode', -label => WebGUI::International::get(9, "Asset_WSClient"), + -hoverHelp => WebGUI::International::get('9 description', "Asset_WSClient"), -value => $self->get('debugMode'), ); if ($utf8FieldType eq 'yesNo') { $tabform->getTab("properties")->yesNo ( -name => 'decodeUtf8', -label => WebGUI::International::get(15, "Asset_WSClient"), + -hoverHelp => WebGUI::International::get('15 description', "Asset_WSClient"), -value => $self->get('decodeUtf8'), ); } else { @@ -238,11 +250,13 @@ sub getEditForm { -name => 'sharedCache', -options => $cacheopts, -label => WebGUI::International::get(28, "Asset_WSClient"), + -hoverHelp => WebGUI::International::get('28 description', "Asset_WSClient"), -value => $self->get('sharedCache'), ); $tabform->getTab("properties")->interval ( -name => 'cacheTTL', -label => WebGUI::International::get(27, "Asset_WSClient"), + -hoverHelp => WebGUI::International::get('27 description', "Asset_WSClient"), -value => $self->get('cacheTTL'), ); return $tabform; diff --git a/lib/WebGUI/Help/Asset_WSClient.pm b/lib/WebGUI/Help/Asset_WSClient.pm index c797e4b16..ef81ef877 100644 --- a/lib/WebGUI/Help/Asset_WSClient.pm +++ b/lib/WebGUI/Help/Asset_WSClient.pm @@ -5,6 +5,76 @@ our $HELP = { title => '61', body => '71', fields => [ + { + title => '72', + description => '72 description', + namespace => 'Asset_WSClient', + }, + { + title => '8', + description => '8 description', + namespace => 'Asset_WSClient', + }, + { + title => '13', + description => '13 description', + namespace => 'Asset_WSClient', + }, + { + title => '14', + description => '14 description', + namespace => 'Asset_WSClient', + }, + { + title => '2', + description => '2 description', + namespace => 'Asset_WSClient', + }, + { + title => '3', + description => '3 description', + namespace => 'Asset_WSClient', + }, + { + title => '4', + description => '4 description', + namespace => 'Asset_WSClient', + }, + { + title => '5', + description => '5 description', + namespace => 'Asset_WSClient', + }, + { + title => '16', + description => '16 description', + namespace => 'Asset_WSClient', + }, + { + title => '11', + description => '11 description', + namespace => 'Asset_WSClient', + }, + { + title => '9', + description => '9 description', + namespace => 'Asset_WSClient', + }, + { + title => '15', + description => '15 description', + namespace => 'Asset_WSClient', + }, + { + title => '28', + description => '28 description', + namespace => 'Asset_WSClient', + }, + { + title => '27', + description => '27 description', + namespace => 'Asset_WSClient', + }, ], related => [ { diff --git a/lib/WebGUI/i18n/English/Asset_WSClient.pm b/lib/WebGUI/i18n/English/Asset_WSClient.pm index 9a19cadd6..4d3b3c19a 100644 --- a/lib/WebGUI/i18n/English/Asset_WSClient.pm +++ b/lib/WebGUI/i18n/English/Asset_WSClient.pm @@ -22,60 +22,89 @@ our $I18N = { }, '71' => { - message => q|A Web Services Client allows a user to query data from any SOAP server to which they have access. This wobject is in development status and should not be made accessible to untrusted site administrators.

+ message => q|

A Web Services Client allows a user to query data from any SOAP server to which they have access. This wobject is in development status and should not be made accessible to untrusted site administrators.

-SOAP URI/WSDL
-From the SOAP::Lite man page, "URIs are just identifiers. They may look like URLs, but they are not guaranteed to point to anywhere and shouldn't be used as such pointers. URIs assume to be unique within the space of all XML documents, so consider them as unique identifiers and nothing else." If you specify a URI, you probably also need a proxy below. Alternatively, you can specify a WSDL file in place of a URI. This file refers to a real location at which a SOAP service description can be downloaded and used. For our purposes, the file must end in ".wsdl" to be properly recognized. If you use a WSDL file, you probably don't need to specify a proxy.

- -^International(3,"Asset_WSClient");
-The SOAP proxy is the full name of the server and/or script that is listening for SOAP calls. For example: -http://mydomain.com/cgi-bin/soaplistener.pl

- -^International(4,"Asset_WSClient");
-The SOAP method is the name of the function to be invoked by the SOAP server. Include any extra parameters in the SOAP Call Parameters field below.

- -^International(16,"Asset_WSClient");
-If soapHttpHeaderOverride is set in the WebGUI configuration file, then this -property allows you to override the default MIME type for this page. - -^International(5,"Asset_WSClient");
-If your SOAP call requires any additional parameters, include them here as a valid Perl hash, array or scalar. For example: 'userid' => '12', companyid => '^FormParam("companyid"); Whether you need to use scalar, hash or array is entirely dependent on what your SOAP service expects as input. Likewise, what you get back is entirely dependent on what the service deems to return.'.

- -^International(11,"Asset_WSClient");
-Leave this set to yes unless your page is calling itself with additional parameters. You will probably know if/when you need to turn off default execution. To force execution when it has been disabled by default, pass a form variable "targetWobjects" specifying the name of the SOAP call to force execution. If current cached results already exist for this wobject they will be returned regardless. If you don't want any results returned no matter what, see the Tricks section below.

- -^International(913,"WebGUI");
-Choose a layout for this SOAP client.

- -^International(8,"Asset_WSClient");
-If you're using WebGUI macros in your query you'll want to check this box.

- -^International(13,"Asset_WSClient");
-How many rows should be displayed before splitting the results into separate pages? In other words, how many rows should be displayed per page?

- -^International(14,"Asset_WSClient");
-Because a SOAP call can return complex data structures, you'll need to specify which named variable is to be paginated. If none is specified, no pagination will occur.

- -^International(9,"Asset_WSClient");
-If you want to display debugging and error messages on the page, check this box.

- -^International(15,"Asset_WSClient");
-This option will only display if you have Data::Structure::Util installed. SOAP calls return UTF8 strings even if they may not have UTF8 characters within them. This converts UTF8 characters to that there aren't collisions with any character sets specified in the page header. Decoding is turned off by default, but try turning it on if you see goofy gibberish, especially with the display of copyright symbols and the like.

- -^International(28,"Asset_WSClient");
-By default, SOAP calls are cached uniquely for each user session. By selecting "Global" call returns can be shared between users.

- -^International(27,"Asset_WSClient");
-Number of seconds a SOAP return will be cached. Set to 1 to essentially skip caching.

- -A few other tricks... +

A few tricks...

|, - lastUpdated => 1111124163, +
  • To completely ignore a SOAP wobject, including any possible cached returns, pass a form input param of disableWobjects=call where call is the SOAP method.

    • +|, + lastUpdated => 1119981471, }, + '72 description' => { + message => q|Select a template to display the output of the Web Service Client Asset.|, + lastUpdated => 1119981444, + }, + + '8 description' => { + message => q|If you're using WebGUI macros in your query you'll want to check this box.

    |, + lastUpdated => 1119981444, + }, + + '13 description' => { + message => q|How many rows should be displayed before splitting the results into separate pages? In other words, how many rows should be displayed per page?

    |, + lastUpdated => 1119981444, + }, + + '14 description' => { + message => q|Because a SOAP call can return complex data structures, you'll need to specify which named variable is to be paginated. If none is specified, no pagination will occur.

    |, + lastUpdated => 1119981444, + }, + + '2 description' => { + message => q|From the SOAP::Lite man page, "URIs are just identifiers. They may look like URLs, but they are not guaranteed to point to anywhere and shouldn't be used as such pointers. URIs assume to be unique within the space of all XML documents, so consider them as unique identifiers and nothing else." If you specify a URI, you probably also need a proxy below. Alternatively, you can specify a WSDL file in place of a URI. This file refers to a real location at which a SOAP service description can be downloaded and used. For our purposes, the file must end in ".wsdl" to be properly recognized. If you use a WSDL file, you probably don't need to specify a proxy.

    |, + lastUpdated => 1119981444, + }, + + '3 description' => { + message => q|The SOAP proxy is the full name of the server and/or script that is listening for SOAP calls. For example: +http://mydomain.com/cgi-bin/soaplistener.pl

    |, + lastUpdated => 1119981444, + }, + + '4 description' => { + message => q|The SOAP method is the name of the function to be invoked by the SOAP server. Include any extra parameters in the SOAP Call Parameters field below.

    |, + lastUpdated => 1119981444, + }, + + '5 description' => { + message => q|If your SOAP call requires any additional parameters, include them here as a valid Perl hash, array or scalar. For example: 'userid' => '12', companyid => '^FormParam("companyid"); Whether you need to use scalar, hash or array is entirely dependent on what your SOAP service expects as input. Likewise, what you get back is entirely dependent on what the service deems to return.'.

    |, + lastUpdated => 1119981444, + }, + + '16 description' => { + message => q|If soapHttpHeaderOverride is set in the WebGUI configuration file, then this +property allows you to override the default MIME type for this page.|, + lastUpdated => 1119981444, + }, + + '11 description' => { + message => q|Leave this set to yes unless your page is calling itself with additional parameters. You will probably know if/when you need to turn off default execution. To force execution when it has been disabled by default, pass a form variable "targetWobjects" specifying the name of the SOAP call to force execution. If current cached results already exist for this wobject they will be returned regardless. If you don't want any results returned no matter what, see the Tricks section below.

    |, + lastUpdated => 1119981444, + }, + + '9 description' => { + message => q|If you want to display debugging and error messages on the page, check this box.

    |, + lastUpdated => 1119981444, + }, + + '15 description' => { + message => q|This option will only display if you have Data::Structure::Util installed. SOAP calls return UTF8 strings even if they may not have UTF8 characters within them. This converts UTF8 characters to that there aren't collisions with any character sets specified in the page header. Decoding is turned off by default, but try turning it on if you see goofy gibberish, especially with the display of copyright symbols and the like.

    |, + lastUpdated => 1119981444, + }, + + '28 description' => { + message => q|By default, SOAP calls are cached uniquely for each user session. By selecting "Global" call returns can be shared between users.

    |, + lastUpdated => 1119981444, + }, + + '27 description' => { + message => q|Number of seconds a SOAP return will be cached. Set to 1 to essentially skip caching.

    |, + lastUpdated => 1119981444, + }, + '26' => { message => q|Could not connect to SOAP server.|, lastUpdated => 1055349311