1C:Enterprise 8.3. Developer Guide. Appendix 1. URL Formats

1C:Enterprise 8.3. Developer Guide. Contents


URL FORMATS

This Appendix describes link formats used in 1C:Enterprise. Links can be external or internal. External links are used outside 1C:Enterprise, while internal links are used internally (e.g., for placement into favorites list or operation history).

1.1. URL FORMAT OVERVIEW

A link includes two parts:

„ Infobase host address – describes infobase location relative to client application. This part of the link can be retrieved via the GetInfoBaseURL() method.

„ Internal link – describes location of requested information within the infobase. There are several types of internal links:

„ infobase object

„ infobase object attribute

„ infobase object tabular section attribute

„ infobase register record attribute

„ infobase register record

„ report

„ data processor

„ section

„ section command

„ temporary storage

To create an external link add an internal link to the host address. If a link opens a form or performs navigation in the main window, the following rule is used to generate an external link:

<IB host address>#<internal link>

These links can reference infobase objects, reports, data processors, sectionsections or section commands.

If a link designates a resource, an external link is generated as shown below:

<IB host address>/<internal link>

These links can reference infobase object attributes or information register entries or temporary storage.

TIP

If multiple clients are used to work with the infobase, it is not recommended to save external links to infobase objects as it might render links created in one client inoperable in other clients. For example, an external link created in a web client could fail in a thin client directly connected to the 1C:Enterprise server. It is recommended to save internal links.

If an external reference that has the e1cib signature in its path is passed to the GotoURL() method or a URL dialog, and the reference beginning does not match with an infobase URL, internal reference is extracted from the passed URL and an attempt to go to the extracted part is made. If the attempt fails, the full URL is navigated.

1.2. HOST ADDRESS FORMAT

Depending on the infobase type a host address string might look differently.

File Mode of Infobase

If UNC format is used for the database file path, host address looks like the following:

e1c:/file/<UNC-path>

Example:

//  Infobase file path
{0>\\dbsrvr\bases\mybase<}0{>\\dbsrvr\bases\mybase
//  Host address
e1c:/file/dbsrvr/bases/mybase

If the file path includes the drive letter, host address looks like the following:

e1c:/filev/<Drive letter>/<Base path>

Example:

//  Infobase file path
{0>s:\bases\mybase<}0{>s:\bases\mybase
//  Host address
e1c:/filev/s/bases/mybase

Client/Server Mode of Infobase

For the client/server mode of infobase, link looks like the following:

e1c://server/<server name>/<infobase name>

Example:

//  Infobase connection string
srvsr="srv1C";ref="mybase"

//  Host address
e1c://server/srv1C/mybase

Use of Web Server (Thin Client or Web Client)

If Web server is used to work with the infobase, link looks like the following:

http://<host  address>/<infobase path>
https://<host  address>/<infobase path>

Example:

//  Infobase connection string
http://localhost/mybase

//  Host address
http://localhost/mybase

1.3. INTERNAL LINKS

In general, internal link format looks like the following:

e1cib/<type>/<path>?<parameters>

For a more detailed description of type-dependent link formats see below.

1.3.1. Infobase Object Link

Format:

e1cib/data/<metadata path>?ref="<link ID>"

Where:

„ Metadata path – type of object referenced by the link, e.g., Document.Go- odsConsumption.

„ Link ID – unique object identifier in the infobase.

1.3.2. Infobase Object Attribute Link

Format:

e1cib/data/<metadata path>.<attribute name>?ref="<link ID>"

Where:

„ Metadata path – type of object referenced by the link, e.g., Document.

GoodsConsumption.

„ Attribute name – name of infobase object attribute.

„ Link ID – unique object identifier in the infobase.

1.3.3. Infobase Object Tabular Section Attribute Link

Format:

e1cib/data/<metadata path>.<tabular section name>.<attribute name>?ref="<link ID>"&index="<tabular section row index>"

Where:

„ Metadata path – type of object referenced by the link, e.g., Document. GoodsConsumption.

„ Tabular section name – name of metadata tabular section, e.g., Goods.

„ Attribute name – name of infobase object tabular section attribute.

„ Link ID – unique object identifier in the infobase.

„ Tabular section row index – index of tabular section row.

1.3.4. Infobase Register Record Link

Format:

e1cib/data/<metadata path>?<key field name>="<value>"[&<key field name>="<value>"]

Where:

„ Metadata path – type of object referenced by the link, e.g., InformationRegister.ProductInventory.

„ Key field name – name of register dimension (Period dimension is added for periodic registers).

„ Value is an internal presentation of a filter value. A filter value is coded as described in section 2.2. URL Character Encoding Issues compliant with the RFC 1738 standard (http://www.faqs.org/rfcs/rfc1738.html) – with the help of the % symbol and two hexadecimal characters.

1.3.5. Infobase Register Record Attribute Link

Format:

e1cib/data/<metadata path>.<attribute name>?<key field name>="<value>"[&<key field name>="<value>"]

Where:

„ Metadata path – type of object referenced by the link, e.g., InformationRegister.ProductInventory.

„ Attribute name – name of record attribute.

„ Key field name – name of register dimension (Period dimension is added for periodic registers).

„ Value – internal presentation of filter value.

1.3.6. Report Link

Format:

e1cib/app/<metadata path>

Where:

„ Metadata path – type of object referenced by the link, e.g., Report.Pro- ductInventory.

1.3.7. Data Processor Link

Format:

e1cib/app/<metadata path>

Where:

„ Metadata path – type of object referenced by the link, e.g., DataProces- sor.OrderIssue. 1.3.8.        Section Link

Format:

e1cib/navigationpoint/<section name>

Where:

„ Section name – name of top-level subsystem referenced by the link, e.g., Goodsales.

1.3.9. Link to the Navigation Point Created by the Standard Command

Format:

e1cib/navigationpoint/<section name>/<command name>

Where:

„ Section name – name of top-level subsystem referenced by the link, e.g., Goodsales.

„ Command name – name of command. E.g. Catalog.Products.OpenList.

1.3.10. Temporary Storage Link

Format:

e1cib/tempstorage/<temporary value ID>

Where:

„ Temporary value ID – identifier of temporary value.

1.3.11. Link to an External Data Source Table Record

Format:

e1cib/data/<metadata path>?<key field name>=<value>[&<key field name>=<value>]

Where:

„ Metadata path describes an external data source table, for instance Exter- nalDataSource.Receipts.Table.CheckHeaders.

„ Key field name is a key field name of an external data source table.

„ Value is an internal presentation of a filter value. A filter value is coded as described in section 2.2. URL Character Encoding Issues compliant with the RFC 1738 standard (http://www.faqs.org/rfcs/rfc1738.html) – with the help of the % symbol and two hexadecimal characters.

1.3.12. Links to Global Command Interface Commands

Format:

e1cib/command/<command name>

Where:

„ command name is the command name:

standard command is Catalog.Goods.Create;

common command is CommonCommand.ObjectSearch; command is Catalog.Goods.Command.PrintBarcode. 1.3.13. Links to Lists

Format:

e1cib/command/<list name>

Where:

„ list name is the name of the list being opened, e. g. Catalog.Goods.Documents.GoodsConsumption. 1.3.14. Link to the start page

Format:

e1cib/navigationpoint/desktop

In compatibility mode with version 8.3.2 or later.

Format:

e1cib/navigationpoint/startpage

In compatibility mode with versions earlier than version 8.3.2.

Leave a Reply

Your email address will not be published.

 

1C:Enterprise Developer's Community