The following system-provided keywords are supported for the URL Parameters value associated with each non-system provided Screen Element Version Operation:
<@User@> the current user ID
<@UserGroup@> the user group ID for the current user
<@IsEmployeeRole@> indicates whether or not current user is an employee
<@IsCarrierRole@> indicates whether not current user is a carrier
Note: Smartbench is currently available only to user groups of type ‘Employee’. If defined for a Smartbench screen element version operation, the keyword will always translate to ‘false’.
<@IsCustomerRole@> indicates whether or not current user is a customer
Note: Smartbench is currently available only to user groups of type ‘Employee’. If defined for a Smartbench screen element version operation, the keyword will always translate to ‘false’.
<@Plan@> the current load plan ID, if applicable
<@ReturnURL@> the URL of the current page; this URL can be used by another application (the one that is being punched out to) to return user to the original page
<@ServerHostPort@> the server host port (for example, if customer has setup Test / QA environments configured with ‘hooks’ to ABPP workflows via Screen Elements / Functions, the system could be moved to production changing just the ServerHostPort configuration variable)
<@EntityID@> the entity ID for the selected row (applicable only when a row has been selected from the list); refers to the applicable "key" for the list (for example, will be Load ID from list of loads, Shipment Leg ID from a list of shipment legs, Carrier ID from list of carriers, etc.)
<@EntityType@> the entity type
<@EntityItinerary###@> the itinerary for a load or trip where stops are defined by postal code or geo-codes (latitude and longitude); possible values are: <@EntityItineraryPostalCode< to:>@>, <@EntityItineraryGeoCodes< >< to:>@> (for example, this could be used to pass a list of location attributes to a third-party mapping application; an operation could then be configured using a Screen Element Operation that would render the itinerary for a shipment or load on a map within the TM frame)
<@EntityFromAddressPostalCode@> the postal/zip code for the origin location (applicable for entities with both an origin and destination location; for example,shipment, shipment leg, load)
<@EntityFromAddressCountry@> the country code for the origin location, in ISO-3166 two letter country code format (applicable for entities with both an origin and destination location)
<@EntityFromAddressState@> the state code for the origin location (applicable for entities with both an origin and destination location)
<@EntityFromAddressCity@> the city for the origin location (applicable for entities with both an origin and destination location)
<@EntityFromAddressLatitude@> the latitude for the origin location (applicable for entities with both an origin and destination location)
<@EntityFromAddressLongitude@> the longitude for the origin location (applicable for entities with both an origin and destination location)
<@EntityToAddressPostalCode@> the postal/zip code for the destination location (applicable for entities with both an origin and destination location)
<@EntityToAddressCountry@> the country code for the destination location, in ISO-3166 two letter country code format (applicable for entities with both an origin and destination location)
<@EntityToAddressState@> the address for the destination location (applicable for entities with both an origin and destination location)
<@EntityToAddressCity@> the city for the destination location (applicable for entities with both an origin and destination location)
<@EntityToAddressLatitude@> the latitude for the destination location (applicable for entities with both an origin and destination location)
<@EntityToAddressLongitude@> the longitude for the destination location (applicable for entities with both an origin and destination location)
<@EntityAddressPostalCode@> postal/zip code for the entity’s location (applicable for entities with a single location, such as customer, carrier, consignee, or load/stop)
<@EntityAddressCountry@> the country code for the entity’s location, in ISO-3166 two letter country code format (applicable for entities with a single location)
<@EntityAddressState@> the state code for the entity’s location (applicable for entities with a single location)
<@EntityAddressCity@> the city for the entity’s location (applicable for entities with a single location)
<@EntityAddressLatitude@> the latitude for the entity’s location (applicable for entities with a single location)
<@EntityAddressLongitude@> the longitude for the entity’s location (applicable for entities with a single location)
<@EntityContactURL@> the contact URL for the entity (applicable for entities with a single location)
<@EntityContactEMail@> the contact email address for the entity (applicable for entities with a single location)
<@ModuleContent@> the module content ID used to access current function
<@EntityReferenceNumber###@> the reference number that is associated with applicable entity and designated reference number type, where ### refers to the applicable reference number type
<@EntityAttribute###@> - the attribute that is associated with the entity, where ### represents the internal attribute name for any attribute that can be presented on the list.
Note: As example, Carrier ID for Web screen element versions will be the internal element name (e.g., <@EntityAttributeCarrCode@>). For Smartbench screen element versions, the TMAPI element name is used (e.g., <@EntityAttributeCarrierCode@>). Contact a JDA representative for information regarding specific attribute names.
<@DomDep###@> - the value associated with a domain dependant variable for multi-domain deployments, where ### is the identifier for the configuration variable code prefix (for example, if “http:// <@DomDepABPP@>/myapp/access_1” is defined as the URL for a screen element version operation, the following configuration variables would need to be defined: 1) “DomDepABPP” - placeholder 2) “ABPP.1” - Configuration Variable for the first domain (with host / port value) 3) “ABPP.<N>” - Configuration Variable for the <N-th> domain (with host / port value); this feature is generic and therefore can be used for any domain-dependent value and not just for server/port combinations)
Note: This keyword is not supported by Smartbench screen element version operations. If applied, the keyword will not be translated.
<@UserLocale@> the User’s Locale
<@IsReadOnlyAccess@> Is Read Only Access
<@ParentType@> Parent Type for Selected Entity
<@ParentID@> Parent ID for Selected Entity
<@EntityFromLocationCode@> Origin Location Code
<@EntityFromLocationTypeID@> Origin Location Type ID
<@EntityToLocationTypeID@> Destination Location Type ID
<@EntityLocationCode@> Shipping Location Code
<@EntityLocationTypeID@> Shipping Location Type ID
Notes: Some keywords will be meaningful only when a row has been selected from the applicable list. If the keyword has no association with the selected entity, no data will be passed.
For example: From the List of Shipments, "EntityFromAddressCity" and "EntityToAddressCity will be meaningful because there are two addresses associated with each shipment. However, the "EntityAddressCity" will not be meaningful for shipments as it would not be clear which location was being referenced. By contrast, "EntityAddressCity" will be valid for customers and load/stops since there is just one address associated with these entities.
Note: For keywords that are meaningful only when a row has been selected from the applicable list, if multiple rows have been selected, the applicable values will be repeated for each selected row.
For example: If rows for loads 1234 and 5678 are selected from a list of loads, the HTTP request section might include the following: &SYSTEM_LOAD_ID=1234&SYSTEM_LOAD_ID=5687.
User-defined URL keywords for Screen Element Operations can be established using Configuration Variables.