Manual Synergy - Crear Peticiones Con Pase de Parámetros

8/10/2019 Manual Synergy - Crear Peticiones Con Pase de Parmetros

1/13

4/2/2014 How-to: Creating a Prefilled Request Using a Hyperlink

http://www.exactsoftware.com/docs/DocView.aspx?DocumentID=%7b3b1ce645-2a33-4c4d-ad39-2e9bcf6291df%7d&NoSubject=1&NoHeader=1 1/13

Exact Synergy Enterprise

How-to: Creating a Prefilled Request Using a Hyperlink

Introduction

You can insert a hyperlink in a document that will create a request when clicked. In this hyperlink, you can

pass several parameters that specify the type of request to be created as well as prefill some information

in the new request.

This method is especially useful in several situations such as:

To enable web visitors who are not familiar with Exact Synergy Enterpriseto create specific

requests in your company webs ite such as enquiries or registration of interest

To make it easy for employees reading a po licy document to create requests with proper

information such as for meeting room reservation or purchase requisition, and

To collect feedback from readers using requests linked to the specific document, project, and item.

By prefilling a request, you can also reduce the errors associated with users selecting incorrect

information such as wrong projects or items.

Note:This document assumes you are familiar with URL and web hyperlinks, as well as Exact Synergy

Enterpriserequests and documents.

Description

Topics in this document:

Building the hyperlink

Request parameters

Basic parameters to create requests

Standard parameters to prefill request fieldsExtended parameters for free fields

Finding the GUID or ID

Prefilling fields in a multiple or week request

Building the hyperlink

In order to create requests w ith prefilled information using a hyperlink, you need to first build the URL for

the hyperlink. In this URL, you can specify the relevant parameters and values. The basic URL is in the

following form:

scheme://authority/path/docs/WflRequest.aspx?BCAction=0&query

where:

schemeis "http" or "https" depending on your server configuration

authorityis normally the domain name of your Exact Synergy Enterpriseserver

pathis where Exact Synergy Enterpriseis accessible in your server, and

querycontains the parameters and values to pass to the request form.

Notice that the first parameter, "BCAction", is included in the URL as it is a mandatory parameter. The

parameter and value pairs are to be separated by ampersands ("&"). For simplicity, the following basic

URL will be used in examples throughout this document:

https://exactsynergy.com/synergy/docs/WflRequest.aspx?BCAction=0

Request parameters
http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://-/?-http://www.exactsoftware.com/docs/LogCatalogue.aspx?Catalog=DEFAULT&Assortment=76


2/13



You can use only parameters relevant to the request type being created. If a specified parameter is not

used by the request type, the parameter and value will be ignored. Whenever a parameter or value is

not specified, the field will be left blank or prefilled with the default value defined in the field definition of

the request where applicable.

Basic parameters to create requests

The following table lists the parameters to create a request using a hyperlink:

Parameter Value Result Explanation

BCAction 0 Creates a

request

This parameter is mandatory and the value

specified must be "0" in order to create a

request.

Type Request type

ID

Selects the

request type

This parameter specifies the request type

to create. The expected value is a number

that corresponds to the ID of the request

type in the system. If "Type" is not

specified, the Taskrequest type will be

used if it is active.

For example, the following URL will create a Web supportrequest when the hyperlink is clicked:

http://exactsynergy.com/synergy/docs/WflRequest.aspx?BCAction=0&Type=51

Standard parameters to prefill request fields

The following table lists the standard parameters to prefill certain fields in the new request.


EmployeeID Resource ID Prefills the

Resourcefield

This parameter prefills the Resourcefield

in the new request. The resource ID

number specified must be valid (1 to

999999999) and corresponds to an active

resource. If the number is valid but there is

no active resource with the specified ID,

the Resourcefield w ill be left blank.

StartDate Short date Prefills the

Start date

field

This parameter prefills the Start datefield

in the new request. The value should be in

one of the short date format of

"dd/mm/yyyy", "mm/dd/yyyy", or

"yyyy/dd/mm". You can substitute "/" with

"." or "-" as date separators.

Note:The date that will be prefilled in the

Start datefield depends on the date

format setting of the user who clicked the

hyperlink. For example, if the date

specified in the parameter is "12/11/2008"

and the user's date format setting ismm/dd/yyyy, the system will enter it

following the user's date format setting,

regardless of your intended date format.

However, if the date specified is


3/13



"13/12/2008" for example, the system will

detect that "13" is not a valid month and

convert the date correctly. Due to this

ambiguity, the usage of this parameter is

advisable only in situations where the

user's date format setting is based on the

system date format setting, such as for

web visitors, and Exact Synergy

Enterpriseimplementation where the

system date format se tting is set as

mandatory to all users. For more

information, see explanation on the

Generaland Corporate (Settings)tabs

in Customizing Exact Synergy Enterprise.

EndDate Short date Prefills the End

datefield

This parameter prefills the End datefield

in the new request. The date format is

similar to the "StartDate" parameter and

the explanation in Noteof "StartDate" is

applicable.

ItemCode Item code Prefills the

Itemfield

This parameter prefills the Itemfield in

the new request. If there is no active item

with the specified item code, the Item

field w ill be left blank. In the field

definition, this corresponds to the Item 1

field.

ItemNumberID GUID i Prefills the

Serial

numberfield

This parameter prefills the Serial number

field in the new request. The value is the

GUID of the serial number. See the

procedure after this table on how to locate

the GUID of a serial number. If the GUID is

not valid, the default serial number

specified in the Serial number 1field

definition of the request w ill be used.

Note:If the Serial number 1field in the

request type is defined with dependency

on the Account, Resource, or Item 1

fields, the GUID must be of a serial numberthat fulfills the dependency relationship or

it will be considered invalid.

ItemCount Number Prefills the

Quantity

(Planned)

field

This parameter prefills the Quantity

(Planned)field in the new request. The

number specified w ill be rounded to two

decimal places using the common method

(Symmetric Arithmetic Rounding). If the

quantity specified is not valid, the default

quantity specified in the Quantity 1field


ItemCode_2 Item code Prefills the

Item 2field

This parameter prefills the Item 2field in

the new request. If there is no active item

with the specified item code, the Item 2
http://-/?-http://www.exactsoftware.com/docs/DocView.aspx?DocumentID=%7bc274ddfc-8b51-4491-a3bf-2d6d492861c6%7d&NoSubject=1&NoHeader=1


4/13



field w ill be left blank. In the field

definition, this corresponds to the Item 2

field.

ItemNumberID_2 GUID i Prefills the

Serial

number 2field

This parameter prefills the Serial number

2field in the new request. The value is the

GUID of the serial number. See the

procedure after this table on how to locate

the GUID of a serial number. If the GUID isnot valid, the default serial number

specified in the Serial number 2field


Note:If the Serial number 2field in the


on the Account, Resource, or Item 2

fields, the GUID must be of a serial number

that fulfills the dependency relationship or

it will be considered invalid.

ItemCount_2 Number Prefills the

Quantity 2

field

This parameter prefills the Quantity 2

field in the new request. The number

specified w ill be rounded to two decimal

places using the common method

(Symmetric Arithmetic Rounding). If the

quantity specified is not valid, the default

quantity specified in the Quantity 2field


CustomerID GUID i Prefills the

Accountfield

This parameter prefills the Accountfield in

the new request. The value is the GUID ofthe account. See the procedure after this

table on how to locate the GUID of an

account. If the GUID is not valid, the

default account specified in the Account

field definition of the request w ill be used.

Note:If the Accountfield in the request

type is defined with dependency on the

Item 1, Item 2, Project, or Resource

fields, the GUID must be of an account that

fulfills the dependency relationship or it will

be considered invalid.

CustomerContactID GUID i Prefills the

Contactfield

This parameter prefills the Contactfield in

the new request. The value is the GUID of

the contact. See the procedure after this

table on how to locate the GUID of a

contact. If the GUID is not valid, the default

contact specified in the Contactfield


Note:If the Contactfield in the request

type is defined with dependency on the

Accountfield, the GUID must be of a

contact that fulfills the dependency

relationship or it will be considered invalid.
http://-/?-http://-/?-http://-/?-


5/13



DocID GUID i Prefills the

Document

field

This parameter prefills the Documentfield

in the new request. The value is the GUID

of the document (not the document

number). See the procedure after this

table on how to locate the GUID of a

document. If the GUID is not valid, the

default document specified in the

Documentfield definition of the requestwill be used.

Note:If the Documentfield in the


on the Account, Item 1, Item 2,

Project, Resource, Serial number 1, or

Serial number 2fields, the GUID must be

of a document that fulfills the dependency

relationship or it will be considered invalid.

Priority 1 to 5 Prefills thePriorityfield

This parameter prefills the Priorityfield inthe new request. The value is a number

from one to five. If the value is not a valid

number, a value of 1will be used.

ProjectNumber URL-encoded ii

project code

Prefills the

Projectfield

This parameter prefills the Projectfield in

the new request. If the project code

specified is not valid, the Projectfield will

be left blank. For project codes containing

spaces and special characters, you must

specify the project code in URL-encoded

format. For example, replace spaces with

"+" and ampersands (&) with "%26".

Note:As long as the URL-encoded project

code specified is valid, the Projectfield

will be prefilled with the specified project

code, regardless o f the dependency

relationship. Due to this, if the Project

field in the request type is defined with

dependency on the Account, Item 1,

Item 2, or Resourcefields, you should

manually ensure the URL-encoded project

code fulfills the dependency relationship to

allow the request to be submitted.

FinancialEntryKey GUID i Prefills the

Entryfield

This parameter prefills the Entryfield in

the new request. The value is the GUID of

the financial entry. See the procedure after

this table on how to locate the GUID of a

financial entry. If the GUID is not valid, the

Entryfield will be left blank.

Description URL-encoded ii

text

Prefills the

Description

field

This parameter prefills the Description

field in the new request. If this parameter

is not specified, the default description

specified in the Descriptionfield definition

of the request will be used. For text
http://-/?-http://-/?-http://-/?-http://-/?-


6/13



containing spaces and special characters,

you must specify the description in a URL-

encoded format. For example, replace

spaces with "+" and ampersands (&) with

"%26".

OpportunityID Opportunity

card ID

Prefills the

Opportunity

field

This parameter prefills the Opportunity

field in the new request. The value is the

ID of the opportunity card (not theopportunity code). See the procedure after

this table on how to locate the ID of an

opportunity card. If the opportunity card ID

specified is not valid, the Opportunity

field w ill be left blank.

Note:As long as the opportunity card ID

specified is valid, the Opportunityfield

will be prefilled with the specified

opportunity code, regardless of the

dependency relationship. Due to this, if the

Opportunityfield in the request type is

defined with dependency on the Account

field, you should manually ensure the

opportunity card ID fulfills the dependency

relationship to allow the request to be

submitted.

RequestComments URL-encoded ii

text

Prefills the

Remarks:

Requestfield

This parameter prefills the Remarks:

Requestfield in the new request. For text

containing spaces and special characters,

you must specify the remarks in a URL-

encoded format. For example, replace

spaces with "+" and ampersands (&) with

"%26".

SecurityLevel 0 to 4 or 10 to

101

Prefills the

Security level

field

This parameter prefills the Security level

field in the new request. The value should

be a valid security level number from "0" to

"4" and "10" to "101". If you specify an

integer from "5" to "9", security level "10"

will be used. If you specify an integerhigher than "101", security level "99" will

be used. In case you specify a real

number, the number will be rounded to an

integer using the round-to-even iiimethod.

For more information on security levels,

see Details on Security Levels.

Note:If the value is not a valid number or

integer, security level "0" will be used. Due

to this, ensure that the value specified is

valid to avoid unnecessary security risks.

Extended parameters for free fields
http://www.exactsoftware.com/docs/DocView.aspx?DocumentID=%7b585b6507-41de-4e56-bd0c-b0bfb65dded7%7d&NoHeader=1&NoSubject=1http://-/?-http://-/?-


7/13



The following table lists the extended parameters to prefill certain free fields in the new request. Replace

"XX" at the end of each parameter with the relevant numbers specified in the XXcolumn. Each "XX"

corresponds to the relevant free field. For example, "FreeGuidField_06" corresponds to the Free

:GUID*6field in the new request (this corresponds to Free: GUID 6in the request definition).

Parameter XX Value Result Explanation

FreeBoolField_XX 01 to

05

0 or 1 Pre-sets the

Free: Yes/Nofield

This parameter pre-sets the

corresponding Free: Yes/Nofield in the new request. The

value must be either "0" to clear

the field, or "1" to select the

field. If the value specified is not

a valid number, the field will be

cleared. If this parameter is

absent, the default selection

state of the corresponding Free:

Yes/Nofield de finition of the

request type will be used.

Note:If the value specified is

more than "1", the field may be

selected or the system may

return an error, depending on

the number used. Due to this,

avoid using a number other than

"0" or "1".

FreeDateField_XX 01 to

05

Short date Prefills the

Free: Date

field

This parameter prefills the

corresponding Free: Datefield

in the new request. The date

format is similar to the

"StartDate" parameter and the

explanation in Noteof

"StartDate" is applicable. For

more information, seeprevious

table.

FreeGuidField_XX 01 to

10GUID i Prefills the

Free :GUID*

field


corresponding Free :GUID*field

in the new request.

Note:Since a Free: GUIDfield

can refer to Requests,

Documents, Accounts,

Contacts, Transactions, or

Itemsas specified in the

Selectionsection of the field

definition, be careful to specify

the GUID of the correct entry

meant for the corresponding

Free: GUIDfield.

FreeIntField_XX 01 to

05

Integer Prefills the

Free: Number

field


corresponding Free: Number

field in the new request. You can
http://-/?-http://-/?-


8/13



specify an integer or a real

number. In case you specify a

real number, the number will be

rounded to an integer using the

round-to-even iiimethod.

FreeNumberFie ld_XX 01 to

05

Number Prefills the

Free: Amount

field


corresponding Free: Amount

field in the new request. Thenumber you specify will be

rounded to two decimal places

using the common method

(Symmetric Arithmetic Rounding).

FreeTextField_XX 01 to

15

URL-encoded

text ii

Prefills the

Free: Text

field


corresponding Free: Textfield

in the new request. You can

specify a string of text up to 60

characters including spaces. If

this parameter is not specified,

the default text specified in the

corresponding Free: Textfield

definition of the request will be

used. For text containing spaces

and special characters, you must

specify the remarks in a URL-

encoded format. For example,

replace spaces w ith "+" and

ampersands (&) with "%26".

Table notes

i. GUID: Globally Unique Identifier. See the procedure in Finding the GUID or IDbelow on how to

obtain the relevant GUID.

ii. To help you URL-encode the text, Exactprovides a simple URL encoder at

http://www.synergydemo.nl/urlencode.asp. Type the normal text in the box and click Submit.

You can then copy and use the URL-encoded result as the relevant parameter value.

iii. Also known as Bankers' Roundingor Statistician's Roundingwhere the last digit to keep is

rounded up if the next digit is "6" or more, or "5" followed by non-zero digits. If the next digit is "4"or less, the last digit to keep is not changed. If the next digit is "5" with trailing zeroes, the last

digit to keep is rounded up if it is an odd number, or kept as it is if it is an even number.

Finding the GUID or ID

The following method can be used to find the GUID of a serial number, account, contact, document, or

financial entry; or the ID of an opportunity card:

1. Open the document or card of the relevant entry for viewing. One of the ways to access the

document or relevant card is by searching:

For serial numbers, search at Logistics/Reports/Search/Serial numbersand openthe relevant serial number.

For accounts, search at Customer/Reports/Accounts/Searchand open the relevant

account.

For contacts, go to Customer/Reports/Accounts/Searchand click Contact. Search
http://www.synergydemo.nl/urlencode.asphttp://-/?-http://-/?-http://-/?-


9/13



for the contact and open the contact card by clicking the relevant hyperlink in the Contact:

Last namecolumn.

For documents, search at Documents/Reports/Documents/Search and open the

relevant document.

For financial entries, search at Financial/Reports/Search/Search and open the

transaction by clicking the relevant hyperlink in the Numbercolumn. Then, in the Report:

Transactionscreen, click the hyperlink next to Entry no.under the Generalsection.

For opportunities, search at Customers/Reports/Opportunity

management/Searchand open the relevant opportunity card.

2. Right-click anywhere on the document or card (except on hyperlinks) and select Properties. The

following is a sample Propertiesscreen of a contact card.

3. The GUID or ID is the value in the following parameter of the URL next to Address: (URL):

For the opportunity card, serial number, or account, the value is in the IDparameter.

For the contact, the value is in the ContactIDparameter.

For the document, the value is in the DocumentIDparameter.

For the financial entry, the value is in the EntryGuidparameter.

If the GUID or ID is not fully visible in the Propertiesscreen due to the length of the URL, you can copy

the URL and paste it in a plain text editor for a better view.

Note:For users migrating from Exact Synergy, GUIDs obtained with this method in Exact Synergy

Enterpriseare already in URL-encoded format and you should not URL-encode the GUID manually

anymore as in Exact Synergy.

Prefilling fields in a multiple or week requestApart from creating and prefilling single requests, you can also create and prefill multiple or week

requests. You w ill need to specify the following parameters besides the basic, standard, and extended

parameters:


10/13




EntryType 1 or 2 Creates a

multiple or

week request

This parameter is required to create a

multiple or week request. To create a

multiple request, specify the value as "1"

and to create a week request, specify the

value as "2".

Note:Whether a multiple or week request

can be created depends on whether the

request type supports the creation of

multiple or week request entries.

Rows Integer Specify the

number of

multiple entries

This parameter specifies the number of

multiple entries in the new request,

subject to the number of maximum rows

allowed for the particular request type.

ColX 1 Specify that the

field is enabled

for multiple

entries

This parameter specifies the fields to

include in the multiple entries where "ColX"

is the ID of the specific multiple-entry field.

See the following table for a list of "ColX"

codes.

For example, the IDs of Resource,

Description, and Projectfields are

"Col1", "Col2", and "Col16" respectively.

To include these fields for multiple entries,

specify "&Col1=1&Col2=1&Col16=1" in the

hyperlink.

In a multiple entry, you can also specify the value of the first entry using the standard and extended

parameters. See Standard parameters to prefill request fieldsand Extended parameters for free

fieldstopics in this document for more explanation.

IDs of multiple-entry fields

The following table lists the "ColX" of multiple-entry fields. The Corresponding parametercolumn lists

the parameters you can use to prefill the first value of the multiple-entry fields.

ColX Field

Corresponding

parameter Remarks

Col1 Resource EmployeeID

Col2 Description Description

Col3 Priority Priority

Col4 Private

Col5 Security level

Col6 Start date StartDate This is not available in a week

request. For a week request,

specify the start of the week

instead using the

"WeekStart=yyyy.mm.dd"
http://-/?-http://-/?-


11/13


12/13



with Invoice: Division("Col89").

Col33 Document DocID

Col34 Amount (Planned) In a field definition, this

corresponds to the Amountfield.

Col38 Our ref.

Col40 Payment type

Col41 Documents received

Col42 to Col51 Free: Text 1to

Free: Text 10

FreeTextField_01 to

FreeTextField_10

For Free: Text 11to Free: Text

15, use "Col84" to "Col88".

Col52 to Col56 Free: Date 1to

Free: Date 5

FreeDateField_01 to

FreeDateField_05

Col57 to Col61 Free: Yes/No 1to

Free: Yes/No 5

FreeBoolField_01 to

FreeBoolField_05

Col62 to Col66 Free: Amount 1to

Free: Amount 5

FreeNumberField_01 to

FreeNumberField_05

Col67 to Col71 Free: Number 1to

Free: Number 5

FreeIntField_01 to

FreeIntField_05

Col72 to Col81 Free :GUID*1to

Free :GUID*10

FreeGuidField_01 to

FreeGuidField_10

In a field definition, these

correspond to the Free: GUID 1

to Free: GUID 10fields.

Col82 Remarks: Request RequestComments

Col83 Remarks: Workflow

Col84 to Col88 Free: Text 11to

Free: Text 15

FreeTextField_11 to

FreeTextField_15

For Free: Text 1to Free: Text

10, use "Col42" to "Col51".

Col89 Invoice: Division This must be enabled together

with Invoice("Col32").

Col90 Related (Request)

Col91 Opportunity OpportunityID

For example, the following hyperlink creates a multiple Checked taskrequest with the Resource,

Description, and Documentfields enabled in the five rows of multiple entries and prefills the first

Resourcefield:

https://exactsynergy.com/synergy/docs/WflRequest.aspx?BCAction=0

&EntryType=1&Type=1&Rows=5&Col1=1&Col2=1&Col33=1

&EmployeeID=117562

Related document

How-to: Using Hyperlink to Create Document with Prefilled PropertiesCustomizing Exact Synergy Enterprise

Customizing Request Type Fields (Main Document)

Details on Security Levels

Simple Exact URL Encoding Tool
http://www.synergydemo.nl/urlencode.asphttp://www.exactsoftware.com/docs/DocView.aspx?DocumentID=%7b585b6507-41de-4e56-bd0c-b0bfb65dded7%7d&NoHeader=1&NoSubject=1http://www.exactsoftware.com/docs/DocView.aspx?DocumentID=%7b1b9ec7c2-09aa-47c3-bd5f-43446d740262%7d&NoSubject=1&NoHeader=1http://www.exactsoftware.com/docs/DocView.aspx?DocumentID=%7bc274ddfc-8b51-4491-a3bf-2d6d492861c6%7d&NoSubject=1&NoHeader=1http://www.exactsoftware.com/docs/DocView.aspx?DocumentID=%7bc8ea2e0b-fa18-4cca-a4c2-3ff8f123962f%7d&NoHeader=1&NoSubject=1


13/13


Main Category: Support Product Know How Document Type: Online help main

Category: On-line help files Security level: All - 0

Sub category: General Document ID: 17.098.366

A ssortment: Exact Synergy Enterprise Date: 09-07-2008

Release: Attachment:

Disclaimer
http://www.exactsoftware.com/docs/DocView.aspx?DocumentID=%7b0d6821e8-2417-4ecf-b656-3f95a42ebaa0%7d&noheader=1&nosubject=1http://www.exactsoftware.com/docs/LogCatalogue.aspx?Catalog=DEFAULT&Assortment=76http://www.exactsoftware.com/docs/DocView.aspx?DocumentID={3b1ce645-2a33-4c4d-ad39-2e9bcf6291df}

Manual Synergy - Crear Peticiones Con Pase de Parámetros

Documents

Transcript of Manual Synergy - Crear Peticiones Con Pase de Parámetros